一款超好用的 API 文档生成框架,国产开源,Star 4.8K+

点击上方“Java精选”,选择“设为星标”

别问别人为什么,多问自己凭什么!

下方有惊喜留言必回,有问必答!

每天 08:35 更新文章,每天进步一点点...

介绍

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!

knife4j的前身是swagger-bootstrap-ui,为了契合微服务的架构发展,由于原来swagger-bootstrap-ui采用的是后端Java代码+前端Ui混合打包的方式,在微服务架构下显的很臃肿,因此项目正式更名为knife4j。

目前项目主要的模块如下:

b0e84e62b64b0a156c03733374d105c0.png

此示例根据官方文档介绍演示。

开源仓库

Github

  • https://github.com/xiaoymin/swagger-bootstrap-ui

码云

  • https://gitee.com/xiaoym/knife4j

核心功能

该UI增强包主要包括两大核心功能:文档说明和在线调试

文档说明:根据Swagger的规范说明,详细列出接口文档的说明,包括接口地址、类型、请求示例、请求参数、响应示例、响应参数、响应码等信息,使用swagger-bootstrap-ui能根据该文档说明,对该接口的使用情况一目了然。

在线调试:提供在线接口联调的强大功能,自动解析当前接口参数,同时包含表单验证,调用参数可返回接口响应内容、headers、Curl请求命令实例、响应时间、响应状态码等信息,帮助开发者在线调试,而不必通过其他测试工具测试接口是否正确,简介、强大。

UI增强

同时,swagger-bootstrap-ui在满足以上功能的同时,还提供了文档的增强功能,这些功能是官方swagger-ui所没有的,每一个增强的功能都是贴合实际,考虑到开发者的实际开发需要,是比不可少的功能,主要包括:

  • 个性化配置:通过个性化ui配置项,可自定义UI的相关显示信息

  • 离线文档:根据标准规范,生成的在线markdown离线文档,开发者可以进行拷贝生成markdown接口文档,通过其他第三方markdown转换工具转换成html或pdf,这样也可以放弃swagger2markdown组件

  • 接口排序:自1.8.5后,ui支持了接口排序功能,例如一个注册功能主要包含了多个步骤,可以根据swagger-bootstrap-ui提供的接口排序规则实现接口的排序,step化接口操作,方便其他开发者进行接口对接

快速开始

相信使用过springboot的人大都知道和用过swagger,knife4j的使用方法和swagger几乎一模一样,没有什么学习成本,不同的是展示的接口UI文档更加友好和人性化。下面开始演示一个集成项目,首先来看pom文件依赖:

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

只引入一个knife4j的starter即可,不用其它依赖。springboot的配置文件和启动类不用做任何特殊配置,使用knife4j需要一个swagger的配置类,这个配置类和以前使用swagger几乎是一样的:

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUi
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return  new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("spring.boot.knife4j.controller"))
                .paths(PathSelectors.any())
                .build();
 
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("项目接口文档")
                .description("服务相关接口")
                .contact(new Contact("vincent",null,"vincent549@vip.qq.com"))
                .version("1.0")
                .build();
    }
 
}

可以看到,内容上没什么变化,唯一的变化是类注解需要比原来的swagger多加一个 @EnableSwaggerBootstrapUi。这样knife4j的所有配置都完成了,启动项目可以访问地址:

http://localhost:8080/doc.html?plus=1

来看一下效果:

1c7176c0d2563912841c7117fd073e8c.png

接口配置

下面来配置一个简单的接口,查看文档的展示效果。

首先来看接口的通用返回结果:

@ApiModel("通用接口返回对象")
@AllArgsConstructor
@NoArgsConstructor
@Data
public class Results<T> {
 
    @ApiModelProperty(required = true,notes = "结果码",example = "200")
    private int state;
    @ApiModelProperty(required = true,notes = "时间戳",example = "1567425139000")
    private long time;
    @ApiModelProperty(required = true,notes = "返回信息",example = "SUCCESS")
    private String message;
    @ApiModelProperty(required = true,notes = "返回数据",example = "{\"name\":\"blues\"}")
    private T content;
 
}
@ApiModel("用户对象")
@AllArgsConstructor
@NoArgsConstructor
@Data
public class UserVO {
 
    @ApiModelProperty(required = true,notes = "用户名",example = "blues")
    private String name;
 
    @ApiModelProperty(required = true,notes = "用户返回消息",example = "hello world")
    private String words;
 
  
}

通过上面两个的定义,接口的返回类型就搞定了,下面来看接口:

@Api(tags = "HELLO CONTROLLER 测试功能接口")
@RestController
public class HelloController {
 
 
    @ApiImplicitParams({
            @ApiImplicitParam(name = "name",value = "用户名称",required = true,dataType = "String",paramType = "path",example = "blues")
    })
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "接口返回成功状态"),
            @ApiResponse(code = 500, message = "接口返回未知错误,请联系开发人员调试")
    })
    @ApiOperation(value = "Hello 测试接口", notes = "访问此接口,返回hello语句,测试接口")
    @GetMapping("hello/{name}")
    public Results<UserVO> hello(@PathVariable String name){
        UserVO userVO = new UserVO(name,"hello " + name);
        Results<UserVO> results = new Results<>(200,"SUCCESS", userVO);
        return results;
    }
 
}

这个接口类中分为几个部分需要注意,第一是类上面的@Api注解,描述了整个类的接口分类含义。还有一个是每个接口上面的 @ApiImplicitParams 注解,定义了接口的所有参数。还有@ApiResponses注解,定义了返回时,所有状态码所代表的的含义,最后是@ApiOperation注解,描述了单个接口本身的功能。

定义接口完成后,我们来重启项目,查看文档的效果:

2a2d7146c38ad6bac93c26f9f269aaaf.png

首页上面有一些变化,左侧列表多了HelloController类的整体描述栏目,我们点开这个栏目,可以看到类中定义的所有接口:

ff69fe535ac64d0310eb7911e29dfabc.png

点击这个接口,看到右侧非常详细的接口文档:

a102f9aa12d4c60c4adbe25b9e89b66b.png

上图中展示的是接口地址,接口类型,接口描述和详细的入参描述,下面的相应状态展示了我们定义的两种状态类型,还有接口的回参也非常详细的列了出来:

abfdbd5a50ef5ad7259ee5864c30397d.png

文字描述类型,数据结构,类型都有,还有响应示例,可以说非常清晰了。个人认为这种展示效果比原来的swagger要友好很多。

右侧还有调试功能,可以直接使用来测试接口:

c99efab360085b99823062340ad0ed60.png

在左侧的文档管理中,还可以设置全局参数,支持类似jwt的带权限的测试:

7481da3ae9307065dea19642b2cab698.png

对文档还可以进行个性化设置:

4f9ff69a6273a08563a1ad3c52621ecd.png

说明

上面简单介绍和演示了knife4j,这个starter不仅支持swagger-bootstrap-ui,原始的swagger-ui还是可以使用的:

2eca98c68ec4268786ce07be57286491.png

有些更加喜欢原始风格的同学可以看这个页面。另外,swagger有很多注解,可以使文档展示的信息更加完善和友好,大家可以自行尝试和学习。

版权声明:本文为CSDN博主「夏目 &quot;」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。

https://blog.csdn.net/wuzhiwei549/article/details/105890151

众号“Java精选”所发表内容注明来源的,版权归原出处所有(无法查证版权的或者未注明出处的均来自网络,系转载,转载的目的在于传递更多信息,版权属于原作者。如有侵权,请联系,笔者会第一时间删除处理!

------ THE END ------

b896f2d34572d0a9d68b80a00ce1ba05.png精品资料,超赞福利!6db64dd43012af09d006b43531be75ba.png

>Java精选面试题<
3000+ 道 BAT 大厂面试题在线刷,最新、最全 Java 面试题!

☆ Java进阶学习资料
 Java自学、进阶路线图免费领

483a7fad257e4f20dbc131afd02fca81.png

706209e0e1ba357b4a1c16c571fb1518.png

期往精选  点击标题可跳转

利用 AI 识别修复技术,去除 AV 片马赛克,开发者被抓了!

Mybatis-Plus 支持分库分表了?- 官方神器发布!

DDD 为什么能火起来?和微服务有啥关系?

B 站,又被扫黄了!!!

责任链模式在王者荣耀中的应用,妙啊!

MyBatis 批量插入几千条数据,请慎用 foreach

入职 6 个月,被裁员。。。

在部队当程序员是什么体验?来自一位互联网大佬的自述!

dc23d990fd37a89e243fb5d410d22ae2.png技术交流群!3bc4f3a3db6667770d144a35cb888f24.png

最近有很多人问,有没有读者&异性交流群,你懂的!想知道如何加入。加入方式很简单,有兴趣的同学,只需要点击下方卡片,回复“加群”,即可免费加入交流群!

文章有帮助的话,在看,转发吧!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值