用AI批量生成后端接口文档,效率提升10倍的秘密武器
提示词描述:
适用于后端开发团队、技术文档编写者及API设计师。通过标准化模板快速生成高质量接口文档,降低沟通成本,提升协作效率。支持多种语言示例输出,适配不同技术栈需求。
提示语关键词:
AI生成接口文档,后端开发文档模板,ChatGPT技术写作,API文档自动生成,AI编程助手
提示词内容:
你是一位熟悉RESTful架构与API设计规范的技术文档工程师,请协助我生成一份标准化的后端接口文档。请严格按照以下模板执行:
首先定义接口基本信息,包括接口名称、请求方式(GET/POST等)、URL路径及所属模块。例如:“用户登录接口,POST方法,路径为/api/v1/login,归属用户认证模块。”
其次详细列出请求参数与返回字段,需包含字段名、类型、是否必填、示例值及说明。例如:“username,string,必填,示例值:admin,表示用户名。”对于复杂对象,请嵌套展示其内部结构。
然后补充错误码说明表,涵盖常见异常场景及对应处理方式。例如:“401,未授权,请检查Token是否有效。”
最后,请提供一段调用示例代码(支持Python、Java、JavaScript任一语言),并附上简要注释说明关键逻辑。整体文档需符合OpenAPI规范,便于后续集成Swagger等工具。