diff --git a/README.md b/README.md index f40eb37..cf1f9c0 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,19 @@ docker run -d \ That's it. +# Decouple the api's name from the url path + +The url pointing to a specific api uses the ```name``` value by default. In case you want to decouple the url path from the display name use the ```displayName``` attribute. + +```console +docker run -d \ + -p 8080:80 \ + -e URLS="[{url: 'https://petstore.swagger.io/v2/swagger.json', name: 'petshop', displayName: '(public) Petshop'},{url: 'https://api.apis.guru/v2/specs/instagram.com/1.0.0/swagger.yaml', name: 'instagram', displayName: '(internal) Instagram'}]" \ + volbrene/redoc +``` + +That's it. + ## Environment variables This image uses environment variables for configuration. diff --git a/app/src/RedocPage/RedocPage.js b/app/src/RedocPage/RedocPage.js index e990c32..772b56a 100644 --- a/app/src/RedocPage/RedocPage.js +++ b/app/src/RedocPage/RedocPage.js @@ -11,7 +11,11 @@ class RedocPage extends Component { super(props); this.state = { - availableApis: window._env_.URLS.map(item => ({ value: slugify(item.name).toLowerCase(), label: item.name, url: item.url })), + availableApis: window._env_.URLS.map(item => ({ + value: slugify(item.name).toLowerCase(), + label: item.displayName || item.name, + url: item.url + })), activeApi: { url: '' } diff --git a/app/src/SelectApi/SelectApi.js b/app/src/SelectApi/SelectApi.js index 8ea351b..763cd56 100644 --- a/app/src/SelectApi/SelectApi.js +++ b/app/src/SelectApi/SelectApi.js @@ -7,7 +7,11 @@ class SelectApi extends Component { super(props); this.state = { - availableApis: window._env_.URLS.map(item => ({ value: slugify(item.name).toLowerCase(), label: item.name, url: item.url })), + availableApis: window._env_.URLS.map(item => ({ + value: slugify(item.name).toLowerCase(), + label: item.displayName || item.name, + url: item.url + })), } }