Uso da estrutura de documentação da API online Knife4j no SpringBoot

Índice

1. Sobre Knife4j

Knife4j é uma estrutura de documentação de API online baseada no Swagger 2.

2. Uso básico

2.1 Adicionar dependências ao projeto

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.9</version>
</dependency>

(Nota) As dependências acima são aplicáveis apenas a versões anteriores ao Spring Boot 2.6 (não incluídas).

2.2 Habilitar o modo avançado no arquivo de configuração

Adicione em application.properties:

knife4j.enable=true

2.3 Classe de configuração personalizada

Crie Knife4jConfiguration.class na pasta config do projeto (a classe de configuração criada por você para armazenar o projeto) e adicione a configuração:

O código de configuração é relativamente fixo

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

   
    //指定Controller包路径
    private String basePackage = "com.example.demo.controller";
    
    //分组名称
    private String groupName = "product";
    
    //主机名
    private String host = "http://localhost";
    
    //标题
    private String title = "Demo在线API文档";
    
    //简介
    private String description = "Demo在线API文档";

    //服务条款URL
    private String termsOfServiceUrl = "http://www.apache.org/licenses/LICENSE-2.0";
    
    //联系人
    private String contactName = "xxx";
    
    //联系网址
    private String contactUrl = "http://localhost";
    
    //联系邮箱
    private String contactEmail = "[email protected]";
    
    //版本号
    private String version = "1.0.0";

    @Autowired
    private OpenApiExtensionResolver openApiExtensionResolver;

    @Bean
    public Docket docket() {
        String groupName = "1.0.0";
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .host(host)
                .apiInfo(apiInfo())
                .groupName(groupName)
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build()
                .extensions(openApiExtensionResolver.buildExtensions(groupName));
        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .termsOfServiceUrl(termsOfServiceUrl)
                .contact(new Contact(contactName, contactUrl, contactEmail))
                .version(version)
                .build();
    }

}

2.4 Acesso

Abra o navegador e digite http://localhost:8080/doc.html para acessar. (use o endereço e interface configurados pelo projeto)

3. Configuração detalhada

1) Adicione a anotação `@Api à classe do controlador , configure o atributo `tags` e especifique o nome do módulo (o nome exibido no menu de primeiro nível no documento da API

2) Adicione a anotação @ApiOperation ao método de processamento da solicitação , configure o atributo value e especifique o nome comercial (o nome exibido pelo subitem do menu de primeiro nível no documento da API)

3) Adicione a anotação @ApiOperationSupport` ao método de processamento da solicitação , configure o atributo `order` e o valor é um valor, você pode especificar o número de classificação de exibição do negócio e ele será organizado em ordem crescente de acordo ao valor do atributo de ordem

exemplo:

@Api(tags = "轮播图管理模块")
@RestController
@RequestMapping("/banners")
public class BannerController {
    @Autowired
    private IBannerService iBannerService;
   
    @ApiOperation("添加轮播图")
    @ApiOperationSupport(order=101)
    @PostMapping("/addBanner")
    public JsonResult addNewBanner(@RequestBody BannerDTO bannerDto){
        iBannerService.addNewBanner(bannerDto);
        return JsonResult.ok();
    }
}

4) Adicione a anotação @ApiModelProperty ao atributo do parâmetro POJO do método que processa a requisição , configure o atributo value e especifique a descrição do parâmetro. Além disso, você também pode configurar se este parâmetro é obrigatório através do obrigatório atributo da anotação (não possui a função de verificação, apenas é mostrado nos documentos da API como um envio obrigatório)

@Data
public class BannerDTO implements Serializable { 

    @ApiModelProperty(value="图片地址",required = true,example ="xxx")
    private String imgUrl;
}