Knife4j系列--使用方法

原文网址：Knife4j系列--使用/教程/实例/配置_IT利刃出鞘的博客-CSDN博客

简介

说明

本文用示例介绍knife4j的用法。（SpringBoot整合knife4j）。

Knife4j是一个很好用的接口文档工具，Knife4j是Swagger的升级版。

之前用过Swagger，页面不太好，浏览技术网站时，偶然发现swagger-bootstrap-ui，它能将接口进行归类。早期，swagger-boostrap-ui是1.x版本，如今swagger-bootsrap-ui到2.x，同时也更改名字Knife4j，适用于单体和微服务项目。

Knife4j跟Swagger用法基本一样，swagger用法见：Swagger--使用/教程/实例/配置_IT利刃出鞘的博客-CSDN博客

官网

首页：knife4j
文档：knife4j
gitee地址：https://gitee.com/xiaoym/knife4j

官网文档：1.6 快速开始 | knife4j

效果展示

knife4j跟Tomcat共用一个端口，默认Tomcat是8080。访问地址：

http://localhost:8080/doc.html

分组Url

“分组Url”是文档地址，其他软件（比如apifox）可以将它作为导入文档的url。

此网址可以直接访问：http://localhost:8080/v3/api-docs?group=all

文档

本处展示添加商品接口的文档，可以看到，非常清晰，全部是自动生成。

请求参数

响应参数

调试普通接口

本处展示添加用户的调试接口的方法，可以看到，非常清晰。

测试结果

调试上传文件接口