SpringBoot integrado passos Swagger2

 1, adicionar uma dependência: o primeiro a adicionar Swagger2 dependência em pom.xml:

<! - arrogância依赖-> 
< dependência > 
    < groupId > io.springfox </ groupId > 
    < artifactId > springfox-swagger2 </ artifactId > 
    < versão > 2.6.1 </ versão > 
</ dependência > 
<! - 用于生成在线文档的-> 
< dependência > 
    < groupId > io.springfox </ groupId > 
    < artifactId >springfox-bravata-ui </artifactId > 
    < versão > 2.6.1 </ versão > 
</ dependência >

2, Descrição da classe controlador:

　　(1), para criar uma classe de entidade simples para armazenar dados:

público  classe Livro {
     // 属性
    private Integer lance;
    privado bname String;
    privado bprotagonist String;
    privado BEscreva String; 
    
    pública Book () {
         super (); 
    } 
    Pública Livro (bid Integer, String bname, String bprotagonist, String BEscreva) {
         super ();
        este = .BID lance;
        este .bname = bname;
        este .bprotagonist = bprotagonist;
        este .btype = BEscreva; 
    }
    pública Integer getBid () {
         return licitação; 
    } 
    Pública  vazio setBid (bid Integer) {
         este .BID = licitação; 
    } 
    Pública getBname String () {
         return bname; 
    } 
    Pública  vazio setBname (bname String) {
         este .bname = bname; 
    } 
    Pública getBprotagonist String () {
         return bprotagonist; 
    } 
    Pública  vazio setBprotagonist (bprotagonist String) {
         este .bprotagonist = bprotagonist;
    } 
    Pública getBtype String () {
         return BEscreva; 
    } 
    Pública  vazio setBtype (BEscreva String) {
         este .btype = BEscreva; 
    } 
    @Override 
    pública de Cordas toString () {
         return "Book [bid =" + oferta + "bname =" + bname + "bprotagonist =" + bprotagonist + "BEscreva =" + BEscreva + "]" ; 
    } 
}

　　(2) criar um controlador simples de dados simulados que mostram o efeito de:

retornar livros; 
    } / **
 
 
     
    
     *添加
     * @ param livro 
     * @return 
     * / 
    @GetMapping ( "/ add" )
     público Livro addBook (livro Book) {
         return livro; 
    } 
    
}

3, preparado classe de configuração Swagger2, o controlador de varrimento SpringMVC:

　　A maioria do código de configuração na classe é fixo, mas nota que o controlador não pode ser o nome do pacote errado, são copiados recomendado CTRL + shitf + O {} atalho automaticamente introduzir os pacotes necessários:

/ ** 
 * classe de configuração Swagger2 
 * / 
@Configuration     // denotado como classe de configuração 
@ EnableSwagger2 // para ativar Swagger2 App também escrito para a classe de inicialização 
pública  classe Swagger2Config { 
    
    @Bean 
    pública Docket No. createRestApi () {
         // controlador de varredura em notas Swagger2, .apis dentro Indica que o especificado pacote de 
        retorno  nova nova Docket (DocumentationType.SWAGGER_2) 
                .apiInfo (apiInfo ()) 
                .Select ()                       　　　　　　// nome do pacote do controlador                 
                .apis (RequestHandlerSelectors.basePackage ( "com.szc .controller " )) 
                .paths (PathSelectors.any ())
                .build (); 
    } 

    // descrições API 
    Privada ApiInfo apiInfo () {
         retornar  novo novo ApiInfoBuilder () 
                .title ( "integração SprignBoot sawgger2 Api Documentação online")   // título 
                .description ( "informações que descrevem o documento")   // Descrição 
                .termsOfServiceUrl ( "https://baidu.com")   // URL 
                .version ( "szc_1.0")   // versão 
                .build (); 
    } 

}

4, iniciar projeto SpringBoot na classe App inicialização:

5, após o lançamento bem-sucedido, na barra de endereços do navegador, digite http: // localhost: 8080 / Swagger-ui.html , você pode ver o

 Abrindo o nome do controlador, você pode ver o caminho que o

 A abertura da camada por camada método, um método também pode visualizar os parâmetros desejados ou dados de retorno