How do I install the Restful API Standard skill?

Run npx skillmds@latest add 2428424081cn/restful-api-standard in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

What does the Restful API Standard skill do?

企业级 RESTful API 设计准则 It is listed under Integrations & APIs on SkillMD.

Is Restful API Standard safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Restful API Standard?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Restful API Standard free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Restful API Standard?

2428424081cn (@2428424081cn) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Restful API Standard by 2428424081cn

Name: Restful API Standard
Author: 2428424081cn

File contents

企业级 RESTful API 设计准则

在生成任何 API 接口、路由定义与控制器时，AI 必须严格执行以下设计标准。

一、 URL 命名与路由层级

全名词复数：使用资源复数名词，严禁在 URL 中出现动词（动词由 HTTP Method 表达）。
- ❌ /api/getUserInfo / /api/deleteOrder
- ✅ GET /api/v1/users/{id} / DELETE /api/v1/orders/{id}
层级从属表达：子资源嵌套在父资源之后。
- ✅ GET /api/v1/users/{userId}/orders
Kebab-Case：URL 路径全小写并用连字符连接（如 /api/v1/payment-methods）。

二、 HTTP 谓词与状态码契约

GET：安全且幂等，查询资源。200 OK
POST：创建资源。成功返回 201 Created + Location 头。
PUT：全量替换（幂等）。200 OK 或 204 No Content
PATCH：局部更新。200 OK
DELETE：删除资源（幂等）。成功返回 204 No Content 或 200 OK
错误状态码：
- 400 Bad Request（参数格式错误）
- 401 Unauthorized（未认证/Token 失效）
- 403 Forbidden（已认证但无权限）
- 404 Not Found（资源不存在）
- 409 Conflict（唯一约束/状态机冲突）
- 422 Unprocessable Entity（业务逻辑校验失败）

三、统一响应体信封 (Envelope)

{
  "code": 0,
  "message": "success",
  "data": { ... },
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 100
  },
  "traceId": "c98a1f87-6e42-4b2a"
}

Frequently asked questions

Restful API Standard