Explicação detalhada de como usar o swaggerui no Springboot

Swagger

O Swagger é uma especificação e estrutura independentes do idioma usadas para definir interfaces de serviço e é usado principalmente para descrever APIs RESTful. Ele se concentra em criar excelente documentação e bibliotecas de clientes para APIs. As APIs habilitadas para Swagger podem gerar documentos interativos para métodos de API, permitindo que os usuários descubram a funcionalidade da API experimentando visualmente, visualizando solicitações e respostas, arquivos de cabeçalho e códigos de retorno.

Swagger é usado para definir a documentação da API.

beneficiar:

1. Entrega separada da frente e traseira
2. A documentação da API é muito clara
3. Durante os testes, você não precisa mais usar a entrada de URL no navegador para acessar o controlador
4. A maneira tradicional de inserir URLs é mais problemática para os parâmetros de aprovação em solicitações de postagem (é claro, você pode usar plug-ins de navegador como o Postman)
5. A integração de Spring-Boot e Swagger é mais simples

O Springboot incorpora Swaggerui

etapa

1.Jar Introdução do pacote

 <Depencency> <PupidId> io.springfox </groupiD> <TRAFACTID> springfox-swagger-ui </artifactId> <versão> 2.2.2 </versão <cope> compile </scope> </dependency> <pendency> <pringa> io.springfox </grupo> artef <Versão> 2.2.2 </versão> <cope> Compile </schope> </dependency>

2. Configurando SwaggerConfig baseado no Springboot

 @Configuration @EnableSwagger2Public Classe swaggerConfig {@Bean Public Docket NewsApi () {// Retornar new Docket (documentationType.swagger_2) .apiinfo (apiinfo ()). Select (). Paths (PathSelectors.any (). Built (); Docket Docket = new Docket (documentationType.swagger_2); Docket.enable (true); docket.apiinfo (apiinfo ()). select (). Paths (PathSelectors.any ()). build (); retorno docket; } private apiinfo apiinfo () {return new Apiinfobuilder (). title ("Plataforma de teste do centro de ordem"). Descrição ("Aqui você pode procurar todas as interfaces do projeto e fornecer ferramentas de teste relevantes") .termsofServiceurl ("http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?open") .Contact ("test") .license ("Licença de estrela vermelha da China versão 1.0"). }}

3. Instruções de configuração do WebConfig

Há um problema que precisa receber atenção aqui. Deixe o WebConfig herdar WebMVCAutoconfigurationAdapter em vez de herdar diretamente o WebMVCConfigureRAdApter, caso contrário, a página Swagger não será lançada.

 @Configuration @EnableWebMvcPublic Classe WebConfig estende WebMVCAutoconfigurationAdapter {@Override public void AddCorsMappings (CORSREGISTRO Registry) {Registry.addmapp ("/**"); } @Bean Public Static PropertySourcesPlateHoldConfigurer PropertySourcesPlaceHoldConfigurer () {Return New PropertySourcesPlaceHoldConfigurer (); } @Bean Public filter caracteryEncodingFilter () {caracterencodingFilter caracteryEncodingFilter = new CaracterEncodingFilter (); CaracterEncodingFilter.SetEncoding ("UTF-8"); caracterizencodingfilter.setforcencoding (true); retornar o Filter de CaracterEncodinging; } @Bean Public Mappingjackson2httpMessageConverter Converter () {MappingJackson2httpMessageConverter Converter = new Mappingjackson2httpMessageConverter (); conversor de retorno; } @Bean public ViewResolver getViewResolver () {InternalResourceViewResolver resolver = news InternalResourceViewResolver (); resolver.setViewClass (jstlView.class); resolver.setPrefix ("/jsp"); resolver.SetSuffix (". JSP"); Retornar resolvedor; } @Bean Public StandardServletMultipartResolver getStandardServletMultiparTResolver () {return new StandardServletMultiparTResolver (); }}

4. Acesso à página Swaggerui

http: // localhost: 8080/ProjectName/swagger-ui.html#!/

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.