Repolode
Enviar
springdoc

springdoc/springdoc-openapi

Gera documentação OpenAPI 3 e páginas do Swagger UI ou Scalar para apps Spring Boot, inspecionando os controllers em tempo de execução.

Alternativa open source a:SpringFox

Ver no GitHubSite
Estrelas
3,746
Forks
612
Issues abertas
3
Último commit
ontem

O que é?

springdoc-openapi é uma biblioteca Java para aplicações Spring Boot que inspeciona controllers, configurações, anotações de validação e restrições do Bean Validation em tempo de execução. Ela gera uma especificação OpenAPI 3 servida em JSON e YAML, além de uma página interativa do Swagger UI ou Scalar. Basta adicionar uma única dependência starter para começar, sem necessidade de configuração.

A biblioteca oferece suporte a Spring Web MVC e Spring WebFlux, incluindo endpoints funcionais, e se integra ao Spring Security, OAuth 2, Spring Data REST, Spring HATEOAS e Actuator. Kotlin, Groovy e Javadoc também são compatíveis, e é possível disponibilizar uma API como ferramentas para agentes de IA por meio do MCP. Plugins para Maven e Gradle podem gerar a especificação durante o build, e imagens nativas do GraalVM são compatíveis.

O projeto tem como alvo o Spring Boot 4.x com Java 17 ou superior. A linha 2.x continua disponível para Spring Boot 3, e a linha 1.x não tem mais suporte de código aberto.

Recursos principais

  • 01Gera especificações OpenAPI 3 em JSON e YAML, em tempo de execução, a partir do código Spring Boot.
  • 02Disponibiliza páginas do Swagger UI ou Scalar para explorar a API.
  • 03Oferece suporte a Spring Web MVC, WebFlux e endpoints funcionais.
  • 04Integra-se ao Spring Security, OAuth 2, Spring Data REST e HATEOAS.
  • 05Lê anotações do Bean Validation, como @NotNull, @Min, @Max e @Size.
  • 06Oferece plugins para Maven e Gradle que geram a especificação durante o build.

Casos de uso

  • Documentar uma API REST criada com Spring Boot sem escrever o arquivo OpenAPI manualmente.
  • Oferecer às equipes de frontend ou externas uma página interativa para testar endpoints.
  • Disponibilizar uma API Spring como ferramentas para agentes de IA por meio do MCP.
  • Gerar um arquivo OpenAPI durante o build para geração de código cliente ou verificações de contrato.

Em coleções

Login, SSO e servidores de identidade

Tópicos

#java#spring-boot#openapi#swagger-ui#rest-api#api-documentation#json-format#kotlin#oauth2#openapi-spec

Perguntas frequentes

O que é springdoc-openapi?
Gera documentação OpenAPI 3 e páginas do Swagger UI ou Scalar para apps Spring Boot, inspecionando os controllers em tempo de execução. springdoc-openapi é uma biblioteca Java para aplicações Spring Boot que inspeciona controllers, configurações, anotações de validação e restrições do Bean Validation em tempo de execução. Ela gera uma especificação OpenAPI 3 servida em JSON e YAML, além de uma página interativa do Swagger UI ou Scalar. Basta adicionar uma única dependência starter para começar, sem necessidade de configuração.
springdoc-openapi é gratuito? Qual é a licença?
springdoc-openapi é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
springdoc-openapi ainda é mantido?
Manutenção ativa. O último commit de springdoc-openapi foi em 6 de nov. de 2026.
Para que posso usar springdoc-openapi?
Documentar uma API REST criada com Spring Boot sem escrever o arquivo OpenAPI manualmente. Oferecer às equipes de frontend ou externas uma página interativa para testar endpoints. Disponibilizar uma API Spring como ferramentas para agentes de IA por meio do MCP. Gerar um arquivo OpenAPI durante o build para geração de código cliente ou verificações de contrato.
Onde consigo springdoc-openapi?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/springdoc/springdoc-openapi

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados