Generating Swagger documentation from existing Java code?

Question

Is there a way to generate swagger documentation (in YAML format) from existing Java code?

I am currently using YAML file to generate Java API code, but I am interested whether the reversed process can be achieved. That is if I can generate a YAML file from the existing Java code?

Could you show some examples as to what you're trying to achieve? Do you mean JavaDoc generation, setters/getters, etc.? — Sameer Puri
– Sameer Puri, Commented Aug 5, 2016 at 13:45

Vishrant · Accepted Answer · 2022-02-19 17:11:37Z

13

The process for generating swagger definition from existing code is simple.

Add the following dependencies (I happen to use Maven):

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.9.2</version>
</dependency>

This adds a swagger-ui in your application that can be accessed with

http://<host>:<port>/swagger-ui.html

Hit the API documentation (/v2/api-docs) link and you will get a JSON file that can be easily converted to YAML file using http://editor.swagger.io (Edit -> Convert to YAML)

edited Feb 19, 2022 at 17:11

answered Jun 9, 2019 at 2:15

Vishrant

16.8k12 gold badges87 silver badges139 bronze badges

Sign up to request clarification or add additional context in comments.

9 Comments

Ram Patra Over a year ago

Is there any way to automate this process? For example, I want this yaml file to be generated when I build the project.

Germán Faller Over a year ago

@RamPatra Have you seen github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X and github.com/kongchen/swagger-maven-plugin ?

Ram Patra Over a year ago

@GermanFaller yes, I am using these two in my project and it generates the swagger-ui for me but I haven't been able to figure out the way to generate the yaml file automatically as well.

Germán Faller Over a year ago

Maybe I will write a post to show how to do this. Have you look on localhost:8080/<MyApp>/<Rest Endpoint>/swagger.yaml ? forget <MyApp>, if you have your app on root.

Ram Patra Over a year ago

No, it gives me a 404 error, unfortunately. I am able to access the Swagger UI at http://localhost:9020/swagger-ui.html but when I try to access http://localhost:9020/swagger.yaml I get a 404 error.

|

Collectives™ on Stack Overflow

Generating Swagger documentation from existing Java code?

1 Answer 1

9 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

9 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related