Este artigo apresenta um exemplo de uso do Swagger2 no projeto de inicialização da primavera. É compartilhado com você. Os detalhes são os seguintes:
Adicione dependências Swagger2
Adicione dependências Swagger2 em pom.xml
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version></dependency><dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId><version>2.2.2</version></dependency>
Crie uma classe de configuração Swagger2
Crie a classe de configuração do Swagger2 Swagger2 no Application.java Nível simultâneo.
importar org.springframework.context.annotation.bean; importar org.springframework.context.annotation.configuration; importação springfox.documentation.builders.apiinfobuilder; importação springfox.document.builders.pathlectors; importação springxxxxxxxox.ocuming; springfox.documentation.service.apiinfo; import springfox.documentation.spi.documentationType; importar springfox.documentation.spring.web.plugins.docket; import springfox.documentation.swagger2.annotações.enablewagger2; CREVERESTAPI () {Retorne new Docket (documentationType.swagger_2) .apiinfo (apiinfo ()) .Select () .apis (requestHandlerSelectors.basepackage ("seu próprio nome de pacote de interface externo"). } Apiinfo privado apiinfo () {Return New Apiinfobuilder () .title ("Neo4j Restful Apis") .Description ("The Neo4J Restful APIs Descrição/") .termsOfServiceurl ("") .Contact ("Li Qinghai"). }}Adicione o conteúdo do documento
Após concluir a configuração acima, o conteúdo do documento pode realmente ser produzido, mas esses documentos são direcionados principalmente para a própria solicitação, e a descrição vem principalmente da nomeação de funções e outras funções, que não são amigáveis. Normalmente, precisamos adicionar algumas instruções para enriquecer o conteúdo do documento.
importar io.swagger.annotações.api; importar io.swagger.annotações.apioperation; importar io.swagger.annotações.apiparam;/** * controlador do usuário do sistema * * @author li qinghai * */@api (value = "system interface", tags = "gerenciamento de sistemas")@restonntroll UserController {@AUTOWIRED PRIVADO UserService UserService; /** * Adicionar usuário, registrar * * @param loginName * Faça login na conta * @param nome de usuário * nome do usuário * @param senha * Login senha * @param roleid * função do usuário * @return * @Throws ResourceExistSexception */@apioperation (value = "add user") @PaMAmpApping ("/") public * public * conta ", requerir = true) @RequestParam (requerir = true) @RequestBody String LoginName, @apiparam (name =" nome de usuário ", value =" nome do usuário ", requerido = true) @requestParam (requery = true) @requestbody string username, @apiparam (name =" senha ", value =" Log na senha "" @Apiparam (nome = "roleid", value = "número da função do usuário", requerido = true) @RequestParam (requerido = true) @Requestbody string roleid) lança ResourceExistSexception {existe boolean = this.UserService.Exists (loginName); if (existe) {lança novo ResourceExistSexception (loginName); } Usuário usuário = userservice.create (loginname, senha, nome de usuário, roleid); retornar novo jsonResult (usuário); }}Ver API
Iniciar o programa de inicialização da primavera e visitar: http: // localhost: 8080/swagger-ui.html
API Document Acesso e depuração
Além de visualizar a função da interface, o Swagger também fornece funções de depuração e teste. Podemos clicar no esquema do modelo (área amarela: indica a estrutura de dados) à direita na figura acima. No momento, existe um modelo para o objeto do usuário no valor. Só precisamos modificá -lo um pouco, clique em Experimente abaixo! Botão, você pode concluir uma chamada de solicitação! Várias solicitações GET podem ser usadas para verificar se a solicitação de postagem anterior está correta.
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.