模板使用说明
建议在设计API时遵循这些原则的优先级:首先确保资源识别的清晰性,然后实现统一接口,再考虑无状态通信。在实施过程中,始终考虑API的可演进性,并提供充分的文档支持。生成的API设计指南可作为团队开发标准使用。
模板功能说明
本模板详细阐述RESTful API设计的七大核心原则:资源识别、统一接口、自描述消息、无状态通信、HATEOAS(超媒体驱动)、一致性约束和版本控制。通过具体示例和最佳实践说明,帮助开发者理解如何正确设计资源URI、选择适当的HTTP方法、定义合理的状态码、构建清晰的消息格式以及实施API版本策略。使用本模板可以创建高质量的API,提升系统的互操作性,降低客户端开发难度,并为未来的扩展奠定坚实基础。
参数表单
根据你的业务场景和内容需求,填写下方维度与字段信息,系统会据此拼装结构化 Prompt。
生成结果
完成参数填写并点击「使用此模板生成 Prompt」按钮后,这里会展示可直接复制到大模型里的提示词文本。