接口文档 Knife4j ( Swagger )

Knife4j 底层基于 Swagger 实现,是对 Swagger 的增强封装,主要用于生成符合中国开发者习惯的接口文档。其核心依赖和实现逻辑如下:

Knife4j 使用,参考:https://doc.xiaominfo.com/docs/quick-start

访问 http://ip:port/doc.html 即可查看 Knife4j 接口文档
访问 http://localhost:8080/swagger-ui/index.html 即可查看 Swagger 接口文档


swagger标准常用注解;

注解 标注位置 作用
@Tag controller 类 描述 controller 作用
@Parameter 参数 标识参数作用
@Parameters 参数 参数多重说明
@Schema model 层的 JavaBean 描述模型作用及每个属性
@Operation 方法 描述方法作用
@ApiResponse 方法 描述响应状态码等