Introduction

  • 基于javadoc&KDoc&ScalaDoc解析API文档
  • 注意, 你可以在保持代码零侵入的情况下得到相当完整的api文档, 但是特殊的需求还是需要部分特殊的注释/注解配合
  • 与之相对的是, 你可以灵活的运用配置规则来适应你的项目特性以减少代码侵入.
  • 特殊声明: 由于scala插件中提供的openapi变化过于频繁, 不再作为默认支持选项. 需要在scala项目中使用的开发者可自行从easy-yapi/releases获得支持scala的插件包

功能特性

支持项列表

默认支持 额外(配置)支持
语言 java, kotlin scala
web spring, feign, jaxrs (quarkus / jersey) dubbo
导出到 Postman, Yapi, Markdown -
常用框架 javax.validation, Jackson, Gson swagger

Community

Contributors