Обзор

Используйте Springdoc-openapi для быстрого создания стандартизированной документации API для проекта Springboot. Конкретные шаги использования следующие:

Зависит от конфигурации

существовать pom.xml Добавьте контент, чтобы начать:

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.9</version>
</dependency>

然后существовать Config Настройте базовую информацию описания в , как показано ниже:

@Configuration
public class OpenApiConfig {

    @Bean
    public OpenAPI springOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("SpringDoc API Test")
                        .description("SpringDoc Simple Application Test")
                        .version("0.0.1"));
    }

}

Следующийсуществовать Controller Используйте аннотации для разметки текста следующим образом:

@RestController(value = "/clients")
@Tag(name = "/clients")
public class ClientsRestController {

    @Operation(summary = "This method is used to get the clients.")
    @GetMapping
    public List<String> getClients() {
        return Arrays.asList("First Client", "Second Client");
    }
}

наконец Application.java После запуска приложения,Введите адрес по умолчанию：http://localhost:8081/swagger-ui/index.html Вы можете увидеть документ:

существовать地址 http://localhost:8081/v3/api-docs каталог, openAPI 3.0.1 файл следующего формата:

Подвести итог

Многие из swagger 2 Пользователям, зашедшим сюда, может быть интересно, почему бы не использовать springfox библиотека для создания API,ясуществовать Просто здесь Подвести итогодин раз

Причины для рекомендации Springdoc-openapi следующие:

• Springdoc-openapi является официальным продуктом Spring и более совместим с Springboot (у совместимости Springfox есть подводные камни)
• Сообщество Springdoc-openapi более активно, а Springfox не обновлялся уже 2 года.
• Аннотации Springdoc-openapi ближе к спецификации OpenAPI 3.

Подводя итог, я лично рекомендую использовать Springdoc-openapi для автоматизации документирования API вашего проекта.