documentação da interface é gerado com um springboot arrogância

Primeiro, por que arrogância, ele resolve o problema?

　　Com a popularidade de micro-serviços sprnigboot, springc alto, etc., na concepção de micro-serviços, micro-service pequeno pequenas empresas dezenas, grandes empresas e centenas de milhares de micro-serviços. Assim, muitos micro certamente gerou uma série de chamadas de interface de serviço. A interface chamada certamente irá escrever documentação interface. Na prevalência de micro-serviços, a preparação de milhares de documentação interface, não pode contar com mão de obra para escrever, então arrogância surge, ela utiliza a automatização para obter e resolver o problema da preparação do documento de interface humana. -Lo. Ao adicionar algumas notas através da interface e da forma como a entidade será capaz de gerar após o início da documentação interface de automação projeto.

　　Swagger fornece uma nova maneira de manter a documentação da API, existem quatro grandes vantagens:
1. geração automática de documentação: a necessidade de apenas uma pequena quantidade das notas, documentação da API Swagger podem ser gerados automaticamente com base no código, uma boa garantia a actualidade do documento.
2. Cross-linguística, suporta 40 idiomas.
3. Swagger UI pode ser apresentado é uma documentação de API interativa, podemos tentar chamar a API diretamente na página do documento, eliminando o complexo processo de preparação dos parâmetros de chamada.
4. Você também pode importar os documentos de especificação relacionados ferramentas (como SoapUI), essas ferramentas irá criar automaticamente teste automatizado para nós.

Em segundo lugar, a interface springboot, geração automática de documentação da interface

arquivo de configuração dependências pom.xml

<! - Swagger -> 
<dependency> 
    <groupId> io.springfox </ groupId> 
    <artifactId> springfox-swagger2 </ artifactId> 
    <versão> 2.9.2 </ version> 
</ dependency> 
<! - Swagger -ui -> 
<dependency> 
    <groupId> io.springfox </ groupId> 
    <artifactId> springfox-bravata-ui </ artifactId> 
    <versão> 2.9.2 </ version> 
</ dependency>

2. Modifique o arquivo de configuração application.properties

# Indica se a abrir a arrogância, o ambiente on-line é geralmente fechado 
spring.swagger2.enabled = true

3. Adicione uma arrogância classe de configuração

@Configuration 
@ EnableSwagger2 
classe pública SwaggerConfig { 

    @value (value = "$ {spring.swagger2.enabled}") 
    privada booleana swaggerEnabled; 

    @Bean 
    pública Docket createRestApi () { 
        return new Docket (DocumentationType.SWAGGER_2) 
                .apiInfo (apiInfo ()) 
                .enable (swaggerEnabled) 
                .Select () 
                .apis (RequestHandlerSelectors.basePackage ( "com.guo.boot")) 
                .paths (PathSelectors.any ()) 
                .construa (); 
    } 

    Private ApiInfo apiInfo () { 
        return new ApiInfoBuilder () 
                .title ( "接口文档")
                .description ( "bazofiar接口文档") 
                .termsOfServiceUrl ( "https://wwww.baidu.com") 
                .version ( "1.0") 
                .build (); 
    } 
}

Mais notas:

createRestApi () Este método deve escrever o nome em seu saco, representantes preciso gerar uma tabela de documentação da interface conteúdo do pacote.

Experiência Endereço: http: //127.0.0.1: 8888 / bravata-ui.html

Em terceiro lugar, o caso

controlador

@Api (description = "interface de utilizador") 
@RestController 
@RequestMapping ( "/ Usuário") 
public class a UserController { 

    @ApiOperation ( "a modificação de dados") 

    @GetMapping (value = "/ U / {ID}") 
    UserVO pública o findById (@PathVariable ID int) { 
        a Random nova nova RAND = Random (); 
        UserVO nova nova UserVO = User (); 
        user.setId (ID); 
        Cordas TEMP = "temp01"; 
        user.setUsername (TEMP); 
        user.setPassword (TEMP ); 
        int = n-rand.nextInt (2); 
        user.setSex ((byte) n-); 
        utilizador retorno; 

    } 
    @ApiOperation ( "consulta de utilizador único, informações de utilizador pesquisa por ID de utilizador")
    @PostMapping (value = "/ user / criar", produz = { "application / json; charset = UTF-8"}, consome = { "application / json; charset = UTF-8"}) 
    público UserVO createrUser (@RequestBody userVO userVO) {return userVO;} 

}

feijão

@Api ( "informações do usuário" value =) 
@Data 
classe pública UserVO { 
    @ApiModelProperty (value = "User ID") 
    Privado ID Integer; 

    @ApiModelProperty (value = "Nome de Usuário") 
    private String nome de usuário; 

    @ApiModelProperty (value = " password ") 
    password private string; 

    @ApiModelProperty (value =" 0 = feminino de gênero 1 = masculino ") 
    Byte privada sexo; 

    @ApiModelProperty (value =" sinalizador de exclusão, não exclua o padrão 0, 1 delete ") 
    privado Byte suprimido; 

    @ApiModelProperty (value = "atualização") 
    privado do updateTime dados; 
}

notas comuns:

elógio Anotações comuns
comentário	uso	notas localização
@Api	Descrever o papel da classe	Notas em sala de aula sobre
@ApiOperation	O método de classe acção descrita	Notas sobre o método
@ApiParam	Descreveu o papel dos parâmetros do método de classe	Notas sobre parâmetros para métodos
@ApiModel	Descrever o papel do objeto	Anotação a um resultado pedido de devolução objetos ou objeto
@ApiModelPropert	Descrever o papel de objetos no campo da	objeto de anotação ou a solicitação retorna o campo de resultado objeto