swagger2、rap2与YAPI

一、一个介绍rap和swagger的网站

rap是阿里自研的一个api工具，以前用过需要手写保存，给前端的是一个压缩后的md文件列表，没接触swagger之前还以为是高级的。
近期接触swagger，发现集成到springboot还是很简单的，不需要配置，可直接使用提供的ui组件，不过很多注解会跟系统代码耦合在一起。以下是集成方法：
1、添加依赖

<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.7.0</version>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.7.0</version>
</dependency>

2、配置类
使用@EnableSwagger2开启swagger2

@Profile({"dev", "local", "test"})
@Configuration
@EnableSwagger2
public class Swagger2Config {@BeanDocket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.changhf.controller")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("DEMO Restful APIs").description("这个一个springboot集成swagger提供api文档的demo")// .termsOfServiceUrl("http://blog.csdn.net/chang_li").contact(new Contact("changhf", "www.demo.com", "chang_hfeng@163.com")).version("1.0").build();}
}

3、注解记录

@ApiOperation在指定的路径上，对一个操作或HTTP方法进行描述。
value对操作的简单说明，长度为120个字母，60个汉字。
notes对操作的详细说明。
@ApiImplicitParams
注解ApiImplicitParam的容器类，以数组方式存储。
@ApiImplicitParam
对API的单一参数进行注解。
name参数名称
value参数的简短描述
required是否为必传参数
dataType参数类型，可以为类名，也可以为基本类型（String，int、boolean等）
paramType参数的传入（请求）类型，可选的值有path, query, body, header or form。
defaultValue参数默认值

    @ApiOperation(value = "分配任务", notes = "分配任务，即指定当前节点执行人")@ApiImplicitParams({@ApiImplicitParam(name = "workItemId", value = "工作项id", required = true, dataType = "Long", paramType = "query"),@ApiImplicitParam(name = "userId", value = "用户id", required = true, dataType = "Long", paramType = "query", defaultValue = "110")})@GetMapping("/distributeTask")public WorkItemTaskDTO distributeTask(@RequestParam Long workItemId, @RequestParam Long userId) {try {return workflowService.distributeTask(workItemId, new UserDTO(userId, "lisi", 902L), null);} catch (Exception e) {log.error("分配任务失败", e);}return null;}

4、启动应用程序，访问localhost:8080/swagger-ui.html，点击Show/Hide即可

二、YAPI

http://yapi.smart-xwork.cn/#

swagger2、rap2与YAPI相关推荐

rap2检测哪些接口在使用_Apifox for Mac(接口调试管理工具)
Apifox 是一款用于接口文档定义.Mock 数据.接口自动化测试等等方面的工具,它的功能高效好用,接口云端同步,实时更新.成熟的团队/项目权限管理,满足各类企业的需求.有需要的朋友赶快来使用吧! ...
Springboot集成springFox-Swagger3并通过Yapi做接口管理
添加Swagger2依赖 <dependency><groupId>io.springfox</groupId><artifactId>springfo ...
先写API文档还是先写代码？你需要这款神器Apifox！
代码未动,文档先行其实大家都知道 API 文档先行的重要性,但是在实践过程中往往会遇到很多困难. 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因是 ...
干掉 Postman？测试接口直接生成API文档，这个文档工具真香！
欢迎关注方志朋的博客,回复"666"获面试宝典实不相瞒我的收藏夹里躺着很多优质的开源项目,我有个爱好平时遇到感兴趣的开源项目都会记录下来,然后有时间在慢慢研究.前几天刚给同事分享 ...
推荐一款神级 API 接口管理神器
欢迎关注方志朋的博客,回复"666"获面试宝典 API 本质是一个封装了功能并公开一个用于访问功能的接口!关于API的信息外界无从得知,所以没有好的文档,使用者就无法理解和使用.A ...
还在发愁写API文档？推荐一款阿里腾讯都在用的API管理神器！
欢迎关注方志朋的博客,回复"666"获面试宝典前言 ❝ 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因:写文档短期收益远低于付 ...
干掉Postman？测试接口直接生成API文档，这工具强烈推荐！
最近被身边几个做开发的朋友安利了一款国产的 API 开发调试神器,真的有被惊艳到!!!简直不要太好用! 没想到,中国也有了比 Postman 还好用的软件! 这个 API 开发调试神器就是 ApiPo ...
扔掉 Postman，Apifox 才是 YYDS！
作为软件开发从业者,API 调试是必不可少的一项技能,在这方面 Postman 做的非常出色.但是在整个软件开发过程中,API 调试只是其中的一部分,还有很多事情 Postman 无法完成,或者无法高 ...
接口结构_适用于Mac系统的API接口调试应用
Apifox 中文版是一款适用于 Mac 的API接口调试应用.官方介绍 Apifox = Postman + Swagger + Mock.Apifox 可以用于接口文档.接口调试.Mock.自动化 ...

swagger2、rap2与YAPI

一、一个介绍rap和swagger的网站

二、YAPI

swagger2、rap2与YAPI相关推荐

最新文章

热门文章