全自动生成,帮你和接口文档say goodbye!!

* 戳上方蓝字“开源先锋”关注我


大家好,我是开源君,一个热爱开源的程序员


今天推荐 YApi 推荐给大家,希望能早点下班!

简介


YApi 是高效、易用、功能强大的 API 管理平台,可快速轻松的创建、发布、维护 API,甚至还可进行 Mock 数据等操作!

全自动生成,帮你和接口文档say goodbye!!

全自动生成,帮你和接口文档say goodbye!!全自动生成,帮你和接口文档say goodbye!!

功能特性


全自动生成,帮你和接口文档say goodbye!!

一键生成 API 接口文档


这里介绍个插件就是 YapiIdeaUploadPlugin

可以解析我们平时写的 Javadoc 注释,并自动上传到 YApi 生成 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;
}

自动生成接口文档:全自动生成,帮你和接口文档say goodbye!!

项目地址:
https://github.com/YMFE/yapi


原文始发于微信公众号(开源先锋):全自动生成,帮你和接口文档say goodbye!!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/178369.html

(0)
小半的头像小半

相关推荐

发表回复

登录后才能评论
极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!