生成文档

功能 - 图1

可以通过在右键菜单或者点击左侧导航栏的M 进入展示界面。

界面可以:导出全部、上传全部、预览、查看 MD 源文件、编辑、单文件上传等。

功能 - 图2

其中上传支持 YApi、ShowDoc、语雀

文档目录

功能 - 图3

在右侧窗口支持查看当前项目的所有接口文档列表,按照 Module、Class 树状排列。

Open:生成 Markdown 源文件

Http Client:生成 Http Client 文件

功能 - 图4

功能 - 图5

其中 Markdown 文件可以利用 IDEA 导出 Docs、PDF、HTML,Http Client 文件稍微调整则可以直接运行发起 Http 请求。

配置模版

功能 - 图6

在设置窗口,可以设置模版,只要保留占位字段,其他内容可以任意调整,比如将 **接口名称:** 替换为 ### 接口名称:

功能 - 图7