Repolode
Enviar
swagger-api

swagger-api/swagger-core

Biblioteca Java que gera especificações OpenAPI a partir de anotações no código e APIs REST com JAX-RS, com suporte a OpenAPI 3.x.

Ver no GitHubSite
Estrelas
7,535
Forks
2,255
Issues abertas
219
Último commit
ontem

O que é?

Swagger Core é a implementação Java da OpenAPI Specification. Ele lê anotações e classes de recursos REST em uma aplicação Java e gera um documento OpenAPI que descreve os endpoints, parâmetros, corpos das requisições e modelos de resposta, que ferramentas como Swagger UI podem renderizar como documentação interativa da API.

O projeto é voltado a aplicações com JAX-RS 2 e fornece conjuntos paralelos de artefatos para os namespaces javax e Jakarta. Desde a versão 2.2.0, oferece suporte a OpenAPI 3.1, enquanto a linha 1.x mais antiga atende ao OpenAPI 2.0. Também há um artefato BOM para gerenciar as versões dos módulos individuais em builds com Maven e Gradle.

O repositório é um build Maven multi-módulo que requer Java 11 ou posterior. Os exemplos de integração foram movidos para um repositório separado, swagger-samples.

Recursos principais

  • 01Gera documentos OpenAPI 3.x a partir de anotações Java e recursos JAX-RS.
  • 02Oferece artefatos para os namespaces javax e Jakarta.
  • 03Oferece suporte a OpenAPI 3.1 desde a versão 2.2.0.
  • 04Disponibiliza um BOM para manter versões consistentes das dependências em builds com Maven e Gradle.

Casos de uso

  • Documentar uma API REST Java gerando sua especificação OpenAPI a partir do código.
  • Adicionar documentação interativa da API a um serviço JAX-RS.
  • Migrar um serviço Java do namespace javax para Jakarta sem perder a documentação da API.

Antes de usar

  • É voltado para as APIs Java e JAX-RS 2, portanto não é adequado para outras tecnologias.

Tópicos

#openapi#swagger#rest-api#java#api-documentation#jax-rs#hacktoberfest#open-source#openapi-specification#openapi3

Perguntas frequentes

O que é swagger-core?
Biblioteca Java que gera especificações OpenAPI a partir de anotações no código e APIs REST com JAX-RS, com suporte a OpenAPI 3.x. Swagger Core é a implementação Java da OpenAPI Specification. Ele lê anotações e classes de recursos REST em uma aplicação Java e gera um documento OpenAPI que descreve os endpoints, parâmetros, corpos das requisições e modelos de resposta, que ferramentas como Swagger UI podem renderizar como documentação interativa da API.
swagger-core é gratuito? Qual é a licença?
swagger-core é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
swagger-core ainda é mantido?
Manutenção ativa. O último commit de swagger-core foi em 5 de nov. de 2026.
Para que posso usar swagger-core?
Documentar uma API REST Java gerando sua especificação OpenAPI a partir do código. Adicionar documentação interativa da API a um serviço JAX-RS. Migrar um serviço Java do namespace javax para Jakarta sem perder a documentação da API.
Onde consigo swagger-core?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/swagger-api/swagger-core

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

Projetos relacionados