Show Swagger validation information





.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty{ height:90px;width:728px;box-sizing:border-box;
}







1















Swagger UI does not show request parameter's validation information.
I want to show parameter's min value, max value, format, pattern(regex). Does anyone know the way how I express the parameter's validation information on Swagger UI?










share|improve this question

























  • How did you install Swagger UI? Do you use the vanilla version downloaded from the repository (or installed via npm), or do you use Swagger UI bundled with some framework/library (e.g. Swashbuckle or Springfox)?

    – Helen
    Dec 3 '18 at 9:57


















1















Swagger UI does not show request parameter's validation information.
I want to show parameter's min value, max value, format, pattern(regex). Does anyone know the way how I express the parameter's validation information on Swagger UI?










share|improve this question

























  • How did you install Swagger UI? Do you use the vanilla version downloaded from the repository (or installed via npm), or do you use Swagger UI bundled with some framework/library (e.g. Swashbuckle or Springfox)?

    – Helen
    Dec 3 '18 at 9:57














1












1








1








Swagger UI does not show request parameter's validation information.
I want to show parameter's min value, max value, format, pattern(regex). Does anyone know the way how I express the parameter's validation information on Swagger UI?










share|improve this question
















Swagger UI does not show request parameter's validation information.
I want to show parameter's min value, max value, format, pattern(regex). Does anyone know the way how I express the parameter's validation information on Swagger UI?







rest api swagger






share|improve this question















share|improve this question













share|improve this question




share|improve this question








edited Dec 2 '18 at 14:13







gnk

















asked Dec 2 '18 at 14:00









gnkgnk

439




439













  • How did you install Swagger UI? Do you use the vanilla version downloaded from the repository (or installed via npm), or do you use Swagger UI bundled with some framework/library (e.g. Swashbuckle or Springfox)?

    – Helen
    Dec 3 '18 at 9:57



















  • How did you install Swagger UI? Do you use the vanilla version downloaded from the repository (or installed via npm), or do you use Swagger UI bundled with some framework/library (e.g. Swashbuckle or Springfox)?

    – Helen
    Dec 3 '18 at 9:57

















How did you install Swagger UI? Do you use the vanilla version downloaded from the repository (or installed via npm), or do you use Swagger UI bundled with some framework/library (e.g. Swashbuckle or Springfox)?

– Helen
Dec 3 '18 at 9:57





How did you install Swagger UI? Do you use the vanilla version downloaded from the repository (or installed via npm), or do you use Swagger UI bundled with some framework/library (e.g. Swashbuckle or Springfox)?

– Helen
Dec 3 '18 at 9:57












2 Answers
2






active

oldest

votes


















0














Assuming you use Swagger UI 3.x (the latest version), add showCommonExtensions: true to the Swagger UI initialization code in your index.html file:



const ui = SwaggerUIBundle({
"dom_id": "#swagger-ui",
url: "https://petstore.swagger.io/v2/swagger.json",
showExtensions: true, // <-----
...


Learn more about Swagger UI configuration parameters.






share|improve this answer































    0














    By using openapi 3.0.0 I got a UI with validation information like that displayed in http://editor.swagger.io/. Conversion from openapi 2 to openapi 3 could be done at the following URL. https://mermade.org.uk/openapi-converter






    share|improve this answer
























      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%2f53580982%2fshow-swagger-validation-information%23new-answer', 'question_page');
      }
      );

      Post as a guest















      Required, but never shown

























      2 Answers
      2






      active

      oldest

      votes








      2 Answers
      2






      active

      oldest

      votes









      active

      oldest

      votes






      active

      oldest

      votes









      0














      Assuming you use Swagger UI 3.x (the latest version), add showCommonExtensions: true to the Swagger UI initialization code in your index.html file:



      const ui = SwaggerUIBundle({
      "dom_id": "#swagger-ui",
      url: "https://petstore.swagger.io/v2/swagger.json",
      showExtensions: true, // <-----
      ...


      Learn more about Swagger UI configuration parameters.






      share|improve this answer




























        0














        Assuming you use Swagger UI 3.x (the latest version), add showCommonExtensions: true to the Swagger UI initialization code in your index.html file:



        const ui = SwaggerUIBundle({
        "dom_id": "#swagger-ui",
        url: "https://petstore.swagger.io/v2/swagger.json",
        showExtensions: true, // <-----
        ...


        Learn more about Swagger UI configuration parameters.






        share|improve this answer


























          0












          0








          0







          Assuming you use Swagger UI 3.x (the latest version), add showCommonExtensions: true to the Swagger UI initialization code in your index.html file:



          const ui = SwaggerUIBundle({
          "dom_id": "#swagger-ui",
          url: "https://petstore.swagger.io/v2/swagger.json",
          showExtensions: true, // <-----
          ...


          Learn more about Swagger UI configuration parameters.






          share|improve this answer













          Assuming you use Swagger UI 3.x (the latest version), add showCommonExtensions: true to the Swagger UI initialization code in your index.html file:



          const ui = SwaggerUIBundle({
          "dom_id": "#swagger-ui",
          url: "https://petstore.swagger.io/v2/swagger.json",
          showExtensions: true, // <-----
          ...


          Learn more about Swagger UI configuration parameters.







          share|improve this answer












          share|improve this answer



          share|improve this answer










          answered Dec 3 '18 at 10:30









          HelenHelen

          35.2k482134




          35.2k482134

























              0














              By using openapi 3.0.0 I got a UI with validation information like that displayed in http://editor.swagger.io/. Conversion from openapi 2 to openapi 3 could be done at the following URL. https://mermade.org.uk/openapi-converter






              share|improve this answer




























                0














                By using openapi 3.0.0 I got a UI with validation information like that displayed in http://editor.swagger.io/. Conversion from openapi 2 to openapi 3 could be done at the following URL. https://mermade.org.uk/openapi-converter






                share|improve this answer


























                  0












                  0








                  0







                  By using openapi 3.0.0 I got a UI with validation information like that displayed in http://editor.swagger.io/. Conversion from openapi 2 to openapi 3 could be done at the following URL. https://mermade.org.uk/openapi-converter






                  share|improve this answer













                  By using openapi 3.0.0 I got a UI with validation information like that displayed in http://editor.swagger.io/. Conversion from openapi 2 to openapi 3 could be done at the following URL. https://mermade.org.uk/openapi-converter







                  share|improve this answer












                  share|improve this answer



                  share|improve this answer










                  answered Dec 11 '18 at 2:34









                  gnkgnk

                  439




                  439






























                      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%2f53580982%2fshow-swagger-validation-information%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

                      Monofisismo

                      Angular Downloading a file using contenturl with Basic Authentication

                      Olmecas