Se sua empresa não usou swagger ou nem ouviu falar de arrogância, apresse-se e aprenda este blog, cinco minutos de integração rápida e de idiotas, mas um aplicativo tão simples certamente os chocará.
Primeiro, vamos dar uma breve introdução ao Swagger: Swagger é uma ferramenta mágica para o desenvolvimento de back-end e um canal para a comunicação front-end. O que você pode fazer com Swagger? Primeiro de tudo, você pode basicamente dizer adeus aos testes de unidade no futuro; Em segundo lugar, você não precisa mais escrever documentos da interface e não precisa manter os documentos depois de escrevê -los. O Swagger pode simular completamente as solicitações HTTP, e a diferença entre parâmetros de entrada e saída e condições reais é quase zero. Dito isto, vamos fazer algumas informações!
Quatro partes integradas:
Etapa 1: importar duas dependências. Se você não é um projeto Maven, pode procurar o pacote JAR. Lembre -se de que apenas dois são necessários. Vi que introduzi sete ou oito deles em outros tutoriais, o que é um desperdício.
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version></dependency><dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version></dependency>
Etapa 2: Adicione uma classe (copie o seguinte, observe que você pode modificar o nome e o endereço do pacote)
/** * Configuração do swagger * * @Author wq * @since 2017-05-16 */ @EnableWebmvc @EnableSwagger2 @ConfigurationPublic Classe swaggerConfig {@Bean Public Docket Createrestapi () {Return Docket Docket (DocumatoryPeTo.swagger_2) .ApTerEstapi () {Return Docket (DocumationTyPeTe.swagger_2) .ApTerestapi () {Return new Docket (DocumationTyPeTe.swagger_2) .ApTerEstapi () {Return new DocketEnTeat () .Ap (). .apis (requestHandlerSelectors.basepackage ("com.z*.b*.c*.Controller")) // Observe que você modifica o nome do pacote aqui.paths (pathelectors.any ()) .build (); } private apiinfo apiinfo () {retorna new apiinfobuilder () .title ("Lista de interface v1.1.0") // qualquer, por favor, regule um pouco.Description ("interface Test") // qualquer um, por favor, regule um pouco.termsofserticeurl ("http: // qualquer um, por favor, e não. IP próprio: Port .Contact ("Laowu") // Não importa (aqui está o pseudônimo do autor) .version ("1.1.0") .build (); }} Etapa 3: Adicione a seguinte configuração ao arquivo de configuração do MVC. Talvez seu arquivo possa ser chamado de Dispatcher.xml! (Basta copiar, nenhuma modificação é necessária)
<MVC: Recursos Mapping = "Swagger-ui.html" location = "ClassPath:/meta-inf/Resources/"/>> <MVC: Recursos Mapping = "/Webjars/**" Location = "ClassPath:/Meta-Inf/Resources/Webjars/"/>
Etapa 4: Adicione anotações sobre métodos e parâmetros
Método:
@Apioperation (value = "tutorial", httpmethod = "post", notas = "tutorial")
Coloque no registro:
@Apiparam (requerir = true, name = "teste", value = "parâmetro tutorial")
Estou preocupado que alguns amigos não entendam bem, então vamos colocar uma foto!
Etapa 5: Inicie o serviço e entre no navegador:
http: // ip: porta/swagger-ui.html
A tela a seguir aparece significa que a tarefa é concluída:
Nota: Se você usar um interceptador em seu projeto, solte o recurso Swagger (você ainda pode copiar a seguinte configuração diretamente, não duvide da v2)
<mvc: exclua-mapping path = "/swagger*/**"> </mvc: exclui-mapping> <mvc: exclui-mapping path = "/v2/**"> </mvc: exclude-mapping> <mvc: exclua-mapping Path = "/webjars/**"> </mvc: exclua-se-mpaging>
O exposto acima é todo o conteúdo deste artigo. Espero que seja útil para o aprendizado de todos e espero que todos apoiem mais o wulin.com.