You are reading the archived documentation for springdoc-openapi v1 (Spring Boot 1.x and 2.x), which is no longer maintained. See the current springdoc-openapi documentation for supported releases.

Introduction

springdoc-openapi java library helps to automate the generation of API documentation using spring boot projects. springdoc-openapi works by examining an application at runtime to infer API semantics based on spring configurations, class structure and various annotations.

Automatically generates documentation in JSON/YAML and HTML format APIs. This documentation can be completed by comments using swagger-api annotations.

This library supports:

  • OpenAPI 3

  • Spring-boot (v1 and v2)

  • JSR-303, specifically for @NotNull, @Min, @Max, and @Size.

  • Swagger-ui

  • Scalar

  • OAuth 2

  • GraalVM native images

The following video introduces the Library:

springdoc-openapi presentation

This is a community-based project, not maintained by the Spring Framework Contributors (Pivotal).