Как создать Swagger UI из Javadocs?

Question

Я могу генерировать swagger UI в моем загрузочном приложении Spring из аннотаций @Api @ApiOperation, @ApiResponses.

Эти аннотации делают код немного грязным. Интересно, как я могу генерировать документацию по swagger для своих API-оконечных точек из javadocs.

Answer 1

Есть простой способ сделать это. Вам нужно добавить аннотацию @ EnableSwagger2.

1. Вы можете добавить следующие зависимости в pom.xml

      <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>
   

2. Добавьте примечание ниже к своему основному классу приложения Spring Boot.

   @EnableSwagger2
   public class Authentic {
   
       public static void main(String[] args) {
           SpringApplication.run(Authentic.class, args);
       }
   }
   
   

3. Ниже описано, как получить доступ к документации API.

Например, URL: http://localhost:8080/swagger-ui.html#/