Project Name | Stars | Downloads | Repos Using This | Packages Using This | Most Recent Commit | Total Releases | Latest Release | Open Issues | License | Language |
---|---|---|---|---|---|---|---|---|---|---|
Springfox | 5,789 | 13,090 | 583 | 3 months ago | 26 | July 14, 2020 | 295 | apache-2.0 | Java | |
Automated JSON API documentation for API's built with Spring | ||||||||||
Springdoc Openapi | 2,623 | 5 | 29 | 4 days ago | 139 | August 21, 2022 | 6 | apache-2.0 | Java | |
Library for OpenAPI 3 with spring-boot | ||||||||||
Spring Restdocs | 1,104 | 121 | 44 | 13 days ago | 21 | January 15, 2022 | 42 | apache-2.0 | Java | |
Test-driven documentation for RESTful services | ||||||||||
Springdoc Openapi Demos | 400 | 3 days ago | 14 | May 06, 2020 | 3 | Java | ||||
Demo for OpenAPI 3 with spring-boot | ||||||||||
Spring Petclinic Rest | 383 | a month ago | 8 | apache-2.0 | Java | |||||
REST version of the Spring Petclinic sample application | ||||||||||
Restdocs Api Spec | 299 | 22 days ago | 14 | May 02, 2022 | 35 | mit | Kotlin | |||
Adds API specification support to Spring REST Docs | ||||||||||
Curso Especialista Spring Rest | 264 | 14 days ago | Java | |||||||
Projeto do curso Especialista Spring REST da AlgaWorks | ||||||||||
Hikaku | 179 | 6 | 10 months ago | 15 | September 02, 2021 | 17 | apache-2.0 | Kotlin | ||
A library that tests if the implementation of a REST-API meets its specification. | ||||||||||
Springdoc Openapi Gradle Plugin | 106 | 4 days ago | 15 | apache-2.0 | Kotlin | |||||
Library for OpenAPI 3 with spring-boot | ||||||||||
Springdoc Openapi Maven Plugin | 106 | 4 days ago | 7 | March 20, 2022 | 2 | apache-2.0 | Java | |||
Library for OpenAPI 3 with spring-boot |
springdoc-openapi
is on Open Collective.
If you ❤️ this project consider becoming a sponsor.
If you already use the springdoc-openapi
, please do not forget adding a github star to this repository.
This project is sponsored by
The springdoc-openapi Java library helps automating 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.
The library automatically generates documentation in JSON/YAML and HTML formatted pages.
The generated documentation can be complemented using swagger-api
annotations.
This library supports:
For spring-boot v3 support, make sure you use springdoc-openapi v2
The following video introduces the Library:
This is a community-based project, not maintained by the Spring Framework Contributors ( Pivotal)
server
: The server name or IPport
: The server portcontext-path
: The context path of the applicationspringdoc-openapi-ui
library to the list of your project dependencies (No
additional configuration is needed): <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>last-release-version</version>
</dependency>
# swagger-ui custom path
springdoc.swagger-ui.path=/swagger-ui.html
server
: The server name or IPport
: The server portcontext-path
: The context path of the application/v3/api-docs.yaml
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-webmvc-core</artifactId>
<version>last-release-version</version>
</dependency>
# /api-docs endpoint custom path
springdoc.api-docs.path=/api-docs
springdoc-openapi
endpoints, add a
custom springdoc property, in your spring-boot
configuration file:# disable api-docs
springdoc.api-docs.enabled=false
To generate documentation automatically, make sure all the methods declare the HTTP Code responses using the annotation: @ResponseStatus.
The library uses spring-boot application auto-configured packages to scan for the
following annotations in spring beans: OpenAPIDefinition and Info.
These annotations declare, API Information: Title, version, licence, security, servers,
tags, security and externalDocs.
For better performance of documentation generation, declare @OpenAPIDefinition
and @SecurityScheme
annotations within a Spring managed bean.
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-webflux-ui</artifactId>
<version>last-release-version</version>
</dependency>
# swagger-ui custom path
springdoc.swagger-ui.path=/swagger-ui.html
The springdoc-openapi
libraries are hosted on maven central repository.
The artifacts can be viewed accessed at the following locations:
Releases:
Snapshots:
springdoc-openapi is relevant and updated regularly due to the valuable contributions from its contributors.
Thank you all for your support!