快速上手
介绍
安装
使用
导出到yapi
导出到postman
导出到markdown
导出rpc文档
进阶使用
Yapi Render
Call Api
Script Executor
注释规范
java注释demo
EasyYapi
文档
配置
demo
框架支持
QA
Introduction
基于
javadoc
&
KDoc
&
ScalaDoc
解析API文档
注意, 你可以在保持代码零侵入的情况下得到相当完整的api文档, 但是特殊的需求还是需要部分特殊的注释/注解配合
与之相对的是, 你可以灵活的运用
配置规则
来适应你的项目特性以减少代码侵入.
特殊声明: 由于scala插件中提供的
openapi
变化过于频繁, 不再作为默认支持选项. 需要使用在scala项目的开发者可自行从
easy-yapi/releases
获得支持scala的插件包
功能特性
导出API文档到
Postman
导出API文档到
Yapi
导出API文档到
Markdown
导出RPC文档到
Yapi
导出RPC文档到
Markdown
在
IDEA
中直接发起API请求
Api DashBoard
YApi DashBoard
Contribution
帮助维护文档:
easyyapi.com
请将您的PR提交到dev分支
讨论
新的功能
or提交
BUG
:
Issues
开发
新的功能
or修复
BUG
:
PR
维护推荐配置:
.recommend.easy.api.config
丰富demo:
spring-demo
修复IDE兼容问题:
intellij-kotlin
Contributors
tangcent
echo-layker
zjz6b6
gcdd1993
MiZhuo
安装