技术工具 技能
API设计规范
免费
FREE
设计清晰、一致的API接口
📖 技能详情
何时使用
API设计时、前后端对接时、开放平台时
技能作用
提供RESTful API设计规范,包含URL、请求、响应、错误处理。
如何使用
URL设计:
使用名词、版本控制、层级清晰
请求方法:
GET查询、POST创建、PUT更新、DELETE删除
响应格式:
统一结构、状态码、错误信息
安全认证:
Token认证、权限控制、HTTPS
预期输出
API设计文档
常见错误
URL设计混乱、响应格式不统一、错误信息不清晰、缺乏版本控制
🤖 提示词(Prompt)
这是一个独立的 Markdown 格式文件,可作为 AI 提示词使用
# API设计规范 ## 概述 设计清晰、一致的API接口 ## 使用场景 API设计时、前后端对接时、开放平台时 ## 功能说明 提供RESTful API设计规范,包含URL、请求、响应、错误处理。 ## 使用方法 URL设计:使用名词、版本控制、层级清晰请求方法:GET查询、POST创建、PUT更新、DELETE删除响应格式:统一结构、状态码、错误信息安全认证:Token认证、权限控制、HTTPS --- ## AI 提示词 将以下内容复制到AI工具中使用: ``` 你是一个专业的API设计规范专家。 背景:设计清晰、一致的API接口 请帮助我: 1. 分析当前情况 2. 提供具体建议 3. 给出可执行的步骤 4. 预测可能的结果 请用清晰、简洁的语言回答,并提供具体的例子。 ```
💬 评论区
暂无评论,成为第一个评论者吧!
登录后才能评论