springfox

Springfox

Status de construção	Cobertura	Análise de código

Nuvem Sonar

Sobre

Para mais informações sobre este projeto visite o site Springfox ou http://springfox.github.io/springfox/

Links úteis

• Documentação de referência
• Repositório de exemplos
• Diretrizes de Contribuição
• Contribuidores principais
• Diretrizes de desenvolvimento e contribuição
• Registro de alterações
• Ambiente de Desenvolvimento
• Instruções de liberação

Começando

Para novos projetos

Para Maven

< dependency >
    < groupId >io.springfox</ groupId >
    < artifactId >springfox-boot-starter</ artifactId >
    < version >3.0.0</ version >
</ dependency >

Para Gradle

  implementation " io.springfox:springfox-boot-starter:<version> " 

Migrando de snapshot anterior

Aplicativos de inicialização Spring

NOTA: Adoraria feedback para melhorar isso

1. Remova dependências explícitas de springfox-swagger2
2. Remova qualquer anotação @EnableSwagger2...
3. Adicione a dependência springfox-boot-starter
4. Springfox 3.x remove dependências de guava e outras bibliotecas de terceiros (ainda não é zero! depende do plugin spring e bibliotecas de API abertas para anotações e modelos), portanto, se você usou predicados/funções de guava, eles precisarão fazer a transição para interfaces de função java 8 .

Migrando da versão 2.x existente

Aplicativos de inicialização Spring

NOTA: Adoraria feedback para melhorar isso

1. Remova dependências explícitas de springfox-swagger2
2. Remova as anotações @EnableSwagger2
3. Adicione a dependência springfox-boot-starter
4. Springfox 3.x remove dependências de guava e outras bibliotecas de terceiros (ainda não é zero! depende do plugin spring e bibliotecas de API abertas para anotações e modelos), portanto, se você usou predicados/funções de guava, eles precisarão fazer a transição para interfaces de função java 8
5. Se você estiver usando WebMvc, mas ainda não usa a anotação @EnableWebMvc , adicione esta anotação.

Mola regular mvc

NOTA: Adoraria feedback para tornar esta experiência melhor

1. Remova dependências explícitas de springfox-swagger2
2. Adicione @EnableOpenApi para API aberta (e @EnableSwagger2WebMvc ou @EnableSwagger2WebFlux para versões mais antigas)
3. Adicionada a biblioteca springfox-oas
4. Springfox 3.x remove dependências de guava e outras bibliotecas de terceiros (ainda não é zero! depende do plugin spring e bibliotecas de API abertas para anotações e modelos), portanto, se você usou predicados/funções de guava, eles precisarão fazer a transição para interfaces de função java 8

Licença

Copyright 2015 Marty Pitt - @martypitt, Dilip Krishnan - @dilipkrish, Adrian Kelly - @adrianbk,

Licenciado sob a Licença Apache, Versão 2.0 (a "Licença"); você não pode usar este arquivo exceto em conformidade com a Licença. Você pode obter uma cópia da Licença em apache.org/licenses/LICENSE-2.0

A menos que exigido pela lei aplicável ou acordado por escrito, o software distribuído sob a Licença é distribuído "COMO ESTÁ", SEM GARANTIAS OU CONDIÇÕES DE QUALQUER TIPO, expressas ou implícitas. Consulte a Licença para saber o idioma específico que rege as permissões e limitações da Licença.

Licença