AI API设计

什么是AI API设计？

如何使用AI API设计

1. 1

   填写需求：在主输入框里填入你想要设计的API对应的业务功能文字描述，尽可能清晰说明业务范围和核心能力，方便AI准确生成符合预期的设计方案

2. 2

   调整要求：这一步是可选操作，如果你有特殊要求，可以在补充要求框补充，比如权限校验规则、分页参数要求、特定返回格式要求等内容

3. 3

   生成方案：点击页面底部的『生成API方案』按钮，触发AI生成内容，等待几秒后就能得到完整的结构化API设计内容

4. 4

   复制导出：生成完成后，你可以直接选中页面里生成的方案内容复制，也可以点击『复制全部』按钮一键复制，内容可直接导入接口文档工具使用

什么场景会用到？

计算示例

注意事项

• 工具仅生成设计方案，不会生成可直接运行的API代码，如需生产可用代码请配合代码生成工具使用
• 生成结果依赖AI大模型的输出，可能会存在端点命名不符合团队规范的情况，需要根据实际业务调整
• 当前仅支持生成RESTful风格API设计，GraphQL、RPC等其他API风格暂不支持
• 工具生成的错误码是行业通用约定，需要替换为你项目自身的错误码体系再使用

常见问题

参考资料

• Fielding RT 博士的REST架构风格原始论文
• MDN Web Docs REST API相关文档

本工具遵循RESTful API设计的通用行业规范，所有生成结果均经过工具编辑组人工校验可用性，工具输出逻辑随大模型接口更新定期优化，由工具集编辑组维护内容。