全自动生成！让你和接口文档说拜拜！！

大家好，我是超可爱的开源小妹！

不知道大家是不是和我一样，对繁杂的接口文档深恶痛绝 o(≧口≦)o

平时已经加班加点去实现产品经理提出的复杂需求了，到最后还要写接口文档给前端的小伙伴对接，实在是让人有些沮丧 ε(┬﹏┬)3

幸运的是，最近项目组引入了一个开源软件，很好的解决了我们不想写文档的这个需求，甚至于无须维护，点击上传按钮就将自动生成 API 文档！！

今天小妹将 YApi 推荐给大家，希望能够帮助小伙伴们能够早点下班！

简介

YApi 是高效、易用、功能强大的 API 管理平台，是为了给开发、产品、测试人员提供更加优雅的接口管理服务。可以帮助开发者们快速轻松的创建、发布、维护 API，甚至还可以利用平台提供的数据写入工具进行 Mock 数据等操作！

YApi 是根据项目进行区分的，能够很好的满足公司多项目管理的需求！

接口可以进行分类，能够维护名称、创建人、状态、接口路径等基础信息。同时也可以查看请求参数和返回数据的结构和描述。

更棒的是，YApi 还支持高级 Mock 数据，可以在后端同学还没有实现完的情况下，让前端的小伙伴根据 Mock 数据提前进行数据对接！

功能特性

• 基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍;
• 扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性;
• 类似 Postman 的接口调试;
• 自动化测试, 支持对 Response 断言;
• MockServer 除支持普通的随机 Mock 外，还增加了 Mock 期望功能，根据设置的请求过滤规则，返回期望数据;
• 支持 Postman, Har, Swagger 数据导入;
• 免费开源，内网部署，信息不用怕泄露。

如何一键生成 API 接口文档

现在同学们最常用的 IDE 应该就是 Intellij IDEA 了。因为 YApi 良好的开源性，吸引了很多开发者对它进行插件开发，这里我要介绍的插件就是 YapiIdeaUploadPlugin。

这个插件可以解析我们平时写的 Javadoc 注释，并自动上传到 YApi 生成 API 文档。也就是说，同学们只需要正常写我们的注释，API 文档这件事就自动搞定了，方便吧！！

   /**
     * 添加或更新课程数据
     *
     * @param courseOpt
     * @return {@link CommonRes}
     */
    @RequestMapping(value = "/test", method = RequestMethod.POST)
    public Course addOrUpdateCourse(@RequestBody CourseParam courseParam){
     ...
    }

class Course {
 /**
  * 主键
  */
 private String id;
 /**
  * 名称
  */
 private String name;
}

class CourseParam {
  /**
  * 名称
  */
 private String name;
}

最终自动生成该接口文档：

小结

小妹这次的分享对于文档苦手来说是一个大大的福音，YApi 能够规范的管理各个项目的接口文档，同时还提供 Mock 数据等实用的功能。

然后再配合 YapiIdeaUploadPlugin 这个插件，能够 0 成本的自动生成 API 文档，这能省出多少个加班的夜晚呀！

问君能有几多愁，开源项目解千愁，我们下期再见！