Swagger UI configuration with swagger-config.yaml












6















As per swagger documentation,




Swagger-UI accepts configuration parameters in four locations.



From lowest to highest precedence:




  1. The swagger-config.yaml in the project root directory, if it exists, is baked into the application

  2. configuration object passed as an argument to Swagger-UI (SwaggerUI({ ... }))

  3. configuration document fetched from a specified configUrl

  4. configuration items passed as key/value pairs in the URL query string




I have tried to put swagger-config.yaml in root pat of application but its not working.



I have followed swagger Installation steps and its working correct.
but steps for swagger custom config is not working. I have kept files as below,



 swagger-ui
|--swagger-config.yaml
|--index.html


swagger-config.yaml



url: "https://petstore.swagger.io/v2/swagger.json"
dom_id: "#swagger-ui"
validatorUrl: "https://online.swagger.io/validator"
oauth2RedirectUrl: "http://localhost:3200/oauth2-redirect.html"


index.html



// Begin Swagger UI call region
const ui = SwaggerUIBundle({
//url: "https://petstore.swagger.io/v2/swagger.json",
//dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
})


Any idea if I am missing anything ?










share|improve this question

























  • How do you run Swagger UI - open the page from the file system, or from a web server, or using npm start?

    – Helen
    Nov 21 '18 at 16:59











  • I tried it on JBoss as well as file system.

    – Mahendra Kapadne
    Nov 21 '18 at 17:01
















6















As per swagger documentation,




Swagger-UI accepts configuration parameters in four locations.



From lowest to highest precedence:




  1. The swagger-config.yaml in the project root directory, if it exists, is baked into the application

  2. configuration object passed as an argument to Swagger-UI (SwaggerUI({ ... }))

  3. configuration document fetched from a specified configUrl

  4. configuration items passed as key/value pairs in the URL query string




I have tried to put swagger-config.yaml in root pat of application but its not working.



I have followed swagger Installation steps and its working correct.
but steps for swagger custom config is not working. I have kept files as below,



 swagger-ui
|--swagger-config.yaml
|--index.html


swagger-config.yaml



url: "https://petstore.swagger.io/v2/swagger.json"
dom_id: "#swagger-ui"
validatorUrl: "https://online.swagger.io/validator"
oauth2RedirectUrl: "http://localhost:3200/oauth2-redirect.html"


index.html



// Begin Swagger UI call region
const ui = SwaggerUIBundle({
//url: "https://petstore.swagger.io/v2/swagger.json",
//dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
})


Any idea if I am missing anything ?










share|improve this question

























  • How do you run Swagger UI - open the page from the file system, or from a web server, or using npm start?

    – Helen
    Nov 21 '18 at 16:59











  • I tried it on JBoss as well as file system.

    – Mahendra Kapadne
    Nov 21 '18 at 17:01














6












6








6








As per swagger documentation,




Swagger-UI accepts configuration parameters in four locations.



From lowest to highest precedence:




  1. The swagger-config.yaml in the project root directory, if it exists, is baked into the application

  2. configuration object passed as an argument to Swagger-UI (SwaggerUI({ ... }))

  3. configuration document fetched from a specified configUrl

  4. configuration items passed as key/value pairs in the URL query string




I have tried to put swagger-config.yaml in root pat of application but its not working.



I have followed swagger Installation steps and its working correct.
but steps for swagger custom config is not working. I have kept files as below,



 swagger-ui
|--swagger-config.yaml
|--index.html


swagger-config.yaml



url: "https://petstore.swagger.io/v2/swagger.json"
dom_id: "#swagger-ui"
validatorUrl: "https://online.swagger.io/validator"
oauth2RedirectUrl: "http://localhost:3200/oauth2-redirect.html"


index.html



// Begin Swagger UI call region
const ui = SwaggerUIBundle({
//url: "https://petstore.swagger.io/v2/swagger.json",
//dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
})


Any idea if I am missing anything ?










share|improve this question
















As per swagger documentation,




Swagger-UI accepts configuration parameters in four locations.



From lowest to highest precedence:




  1. The swagger-config.yaml in the project root directory, if it exists, is baked into the application

  2. configuration object passed as an argument to Swagger-UI (SwaggerUI({ ... }))

  3. configuration document fetched from a specified configUrl

  4. configuration items passed as key/value pairs in the URL query string




I have tried to put swagger-config.yaml in root pat of application but its not working.



I have followed swagger Installation steps and its working correct.
but steps for swagger custom config is not working. I have kept files as below,



 swagger-ui
|--swagger-config.yaml
|--index.html


swagger-config.yaml



url: "https://petstore.swagger.io/v2/swagger.json"
dom_id: "#swagger-ui"
validatorUrl: "https://online.swagger.io/validator"
oauth2RedirectUrl: "http://localhost:3200/oauth2-redirect.html"


index.html



// Begin Swagger UI call region
const ui = SwaggerUIBundle({
//url: "https://petstore.swagger.io/v2/swagger.json",
//dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
})


Any idea if I am missing anything ?







javascript swagger swagger-ui swagger-2.0 openapi






share|improve this question















share|improve this question













share|improve this question




share|improve this question








edited Nov 21 '18 at 15:24







Mahendra Kapadne

















asked Nov 21 '18 at 14:57









Mahendra KapadneMahendra Kapadne

20117




20117













  • How do you run Swagger UI - open the page from the file system, or from a web server, or using npm start?

    – Helen
    Nov 21 '18 at 16:59











  • I tried it on JBoss as well as file system.

    – Mahendra Kapadne
    Nov 21 '18 at 17:01



















  • How do you run Swagger UI - open the page from the file system, or from a web server, or using npm start?

    – Helen
    Nov 21 '18 at 16:59











  • I tried it on JBoss as well as file system.

    – Mahendra Kapadne
    Nov 21 '18 at 17:01

















How do you run Swagger UI - open the page from the file system, or from a web server, or using npm start?

– Helen
Nov 21 '18 at 16:59





How do you run Swagger UI - open the page from the file system, or from a web server, or using npm start?

– Helen
Nov 21 '18 at 16:59













I tried it on JBoss as well as file system.

– Mahendra Kapadne
Nov 21 '18 at 17:01





I tried it on JBoss as well as file system.

– Mahendra Kapadne
Nov 21 '18 at 17:01












0






active

oldest

votes











Your Answer






StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");

StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});

function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});


}
});














draft saved

draft discarded


















StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53414776%2fswagger-ui-configuration-with-swagger-config-yaml%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown

























0






active

oldest

votes








0






active

oldest

votes









active

oldest

votes






active

oldest

votes
















draft saved

draft discarded




















































Thanks for contributing an answer to Stack Overflow!


  • Please be sure to answer the question. Provide details and share your research!

But avoid



  • Asking for help, clarification, or responding to other answers.

  • Making statements based on opinion; back them up with references or personal experience.


To learn more, see our tips on writing great answers.




draft saved


draft discarded














StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53414776%2fswagger-ui-configuration-with-swagger-config-yaml%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown





















































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown

































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown







Popular posts from this blog

Guess what letter conforming each word

Run scheduled task as local user group (not BUILTIN)

Port of Spain