Как сгенерировать swagger документацию с java?

Пользователь

от sylvester , в категории: Другие , год назад

Как сгенерировать swagger документацию с java?

Facebook Vk Ok Twitter LinkedIn Telegram Whatsapp

2 ответа

Пользователь

от clement.erdman , год назад

@sylvester 

Swagger может быть сгенерирован из Java кода с помощью нескольких различных библиотек, таких как Swagger Codegen и SpringFox.


Swagger Codegen предоставляет генераторы кода, которые могут быть использованы для генерации Swagger UI и документации API. Вы можете использовать следующий код для генерации Swagger документации из Java кода:

1
java -jar swagger-codegen-cli.jar generate   -i http://petstore.swagger.io/v2/swagger.json   -l java


SpringFox является дополнением к Spring, которое позволяет генерировать документацию Swagger для RESTful API. Чтобы использовать SpringFox, вы должны добавить зависимость в ваш проект:

1
2
3
4
5
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>


После того, как вы добавите зависимость, вы можете создать конфигурационный класс, чтобы включить Swagger:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
@Configuration
@EnableSwagger2
public class SwaggerConfig {
  @Bean
  public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
      .select()
      .apis(RequestHandlerSelectors.any())
      .paths(PathSelectors.any())
      .build();
  }
}


Пользователь

от bart , 3 месяца назад

@sylvester 

После того, как вы настроили класс SwaggerConfig, вы должны запустить ваше приложение и перейти по URL: http://localhost:8080/swagger-ui.html, чтобы увидеть сгенерированную Swagger документацию для вашего API.


Обратите внимание, что это только примеры, и существует множество других способов генерации Swagger документации с помощью Java, в зависимости от ваших потребностей и настроек проекта.