传源码或接口文件,5 分钟拿到排好版的接口文档初稿。根据代码注释或函数签名,自动生成符合团队规范的 Markdown 接口文档初稿。不替代人工校验,不保证逻辑正确性,需开发者复核后发布。
语言框架、输入来源、上传源文件、要写进哪些内容、字段粒度、文档风格、响应处理、补充说明、格式要求、命名习惯。多数点一下就行,没选的按常见情况替你定,交付时说清哪几项是按默认的。
「从 OpenAPI 文件一键生成带示例的 Markdown」
替他选了:OpenAPI 3.0 YAML · 请求路径与方法、功能简述、请求头说明、Query 参数、Path 参数、Body 参数(JSON结构)、响应状态码、成功响应示例 · 字段+示例值+业务含义 · 联调版(给前端用) · success + error 示例 · 纯 Markdown(.md)