1.将你写的接口通过AI生成Markdown文档
2.在Vs Code中下载扩展“Markdown Preview Enhanced”
3.安装好扩展后打开通过AI生成的Markdown文档。使用快捷键Ctrl+Shift + V快捷创建接口文档
4.右击文档,可选择导出为PDF或者其他格式的文件
注:如需具体生成自己想要的格式。可以自己先创建接口Markdown文档模板,然后将定义好的文档发给AI让其根据该模板给你生成文档。
1.将你写的接口通过AI生成Markdown文档
2.在Vs Code中下载扩展“Markdown Preview Enhanced”
3.安装好扩展后打开通过AI生成的Markdown文档。使用快捷键Ctrl+Shift + V快捷创建接口文档
4.右击文档,可选择导出为PDF或者其他格式的文件
注:如需具体生成自己想要的格式。可以自己先创建接口Markdown文档模板,然后将定义好的文档发给AI让其根据该模板给你生成文档。
接口文档开头可以加上版本管理
# 接口文档
> 文档负责人:`Kong`
> 最后更新:`2025-12-26`
> 文档版本:`v1.0.2`
## 变更记录
| 日期 | 文档版本 | 变更类型 | 变更说明 | 变更人 |
|---:|---|---|---|---|
| 2025-12-24 | v1.0.0 | init | 初版:新增对比、查询接口文档 | Kong |
| 2025-12-25 | v1.0.1 | add | 新增:生成接口文档 | Kong |
| 2025-12-26 | v1.0.2 | add | 新增:上传接口文档 | Kong |