招投标API文档自动生成提示词:Swagger+Markdown一键输出
提示词描述:
帮助开发团队快速生成专业的API文档,支持多种格式输出,便于前后端协作和第三方对接。生成的文档可直接用于项目交付,提升团队协作效率。
提示语关键词:
API文档生成,Swagger接口文档,Java API文档,招投标系统文档,接口文档模板,API测试用例
提示词内容:
请扮演技术文档工程师,为招投标系统API生成完整的接口文档。系统包含20个核心接口,涉及招标管理、投标管理、评标管理三大模块。
文档生成要求:
1. 使用Swagger 3.0注解规范,每个接口需包含@Operation描述、@Parameter参数说明、@ApiResponse响应示例。示例格式:
@Operation(summary = "发布招标公告", description = "招标人创建新的招标项目并发布公告")
2. 提供Postman Collection JSON文件,包含所有接口的请求示例。请求体使用真实业务数据,如招标公告包含项目名称、预算金额、截止时间等字段。
3. 生成Markdown格式的API调用指南,包括:
- 接口分类目录
- 认证方式说明(Bearer Token获取流程)
- 每个接口的请求/响应示例
- 错误码对照表(业务错误码从10001开始)
- 接口调用频率限制说明
4. 提供接口测试用例,覆盖正常场景和异常场景。例如投标接口需测试:截止时间校验、文件大小限制、重复提交检测、CA证书过期等。
5. 生成OpenAPI 3.0规范的YAML文件,可导入Apifox、YApi等工具自动生成Mock数据和客户端SDK。
所有文档需符合企业级API文档规范,包含版本变更记录、接口负责人、SLA承诺等信息。文档语言为中文,技术术语保持英文。