How to generate swagger.json [duplicate]

Question

I am using java spring boot framework to create REST api for my project and I am using "springfox-swagger2 and springfox-swagger-ui" for generating swagger documentation. I am able to see my documentation using the URL http://localhost:8080/swagger-ui.html.

How can I create or generate swagger.json / spec.json, The documentation should not be with this application, we are using a separate application for listing the API docs.

Answer 1

You can get the url with your swagger-ui html page:

GET http://localhost:8080/v2/api-docs?group=App 

And actually you can get all the urls with chrome/firefox develop tools network feature.

Answer 2

If you use Maven, you can generate client and server side documentation (yaml, json and html) by using swagger-maven-plugin

Add this to your pom.xml:

.....  <plugin>                 <groupId>com.github.kongchen</groupId>                 <artifactId>swagger-maven-plugin</artifactId>                 <version>3.0.1</version>                 <configuration>                     <apiSources>                         <apiSource>                             <springmvc>true</springmvc>                             <locations>com.yourcontrollers.package.v1</locations>                             <schemes>http,https</schemes>                             <host>localhost:8080</host>                             <basePath>/api-doc</basePath>                             <info>                                 <title>Your API name</title>                                 <version>v1</version>                                 <description> description of your API</description>                                 <termsOfService>                                     http://www.yourterms.com                                 </termsOfService>                                 <contact>                                     <email>[email protected]</email>                                     <name>Your Name</name>                                     <url>http://www.contact-url.com</url>                                 </contact>                                 <license>                                     <url>http://www.licence-url.com</url>                                     <name>Commercial</name>                                 </license>                             </info>                             <!-- Support classpath or file absolute path here.                             1) classpath e.g: "classpath:/markdown.hbs", "classpath:/templates/hello.html"                             2) file e.g: "${basedir}/src/main/resources/markdown.hbs",                                 "${basedir}/src/main/resources/template/hello.html" -->                             <templatePath>${basedir}/templates/strapdown.html.hbs</templatePath>                             <outputPath>${basedir}/generated/document.html</outputPath>                             <swaggerDirectory>generated/swagger-ui</swaggerDirectory>                             <securityDefinitions>                                 <securityDefinition>                                     <name>basicAuth</name>                                     <type>basic</type>                                 </securityDefinition>                             </securityDefinitions>                         </apiSource>                     </apiSources>                 </configuration>             </plugin> ........ 

You can download *.hbs template at this address: https://github.com/kongchen/swagger-maven-example

Execute mvn swagger:generate JSon documentation will be generated at your project /generated/swagger/ directory. Past it on this address : http://editor.swagger.io

And generate what ever you want ( Server side or Client side API in your preferred technology )