File contents API 设计 Skills 总控
本目录收录 API 设计工作流的所有方法论 skills。
当前 Skills
Skill
适用场景
来源
resource-modeling
REST 资源建模
REST 架构 + Roy Fielding
endpoint-design
端点设计
RFC 7231 / GitHub REST Guidelines
request-response
请求响应结构
JSON:API / OpenAPI
error-handling
错误码设计
RFC 7807 Problem Details
auth-permission
认证鉴权
OAuth 2.0 / RBAC
pagination-filtering
分页筛选排序
Stripe / GitHub 风格
versioning
API 版本管理
Stripe 版本策略
idempotency-retry
幂等和重试
Stripe Idempotency
webhook-async
Webhook 和异步
Stripe Webhooks / SVIX
openapi-mock
OpenAPI 契约和 Mock
OpenAPI 3.1
统一入口
先读 routing.md — 按 API 任务路由
再进入对应 SKILL.md
需要模板时进入 <skill>/templates/
工作思路
skills 可以按需组合:
1. 拿到需求 → 先建模
- resource-modeling(资源建模)
2. 设计端点 → 列清单
- endpoint-design(端点设计)
- request-response(请求响应)
3. 处理错误和权限
- error-handling(错误码)
- auth-permission(认证鉴权)
4. 高级功能
- pagination-filtering(分页筛选)
- idempotency-retry(幂等重试)
- webhook-async(异步通信)
5. 输出和演进
- openapi-mock(OpenAPI + Mock)
- versioning(版本管理)
新增 Skill
按 CONTRIBUTING.md 流程新增。
自动进化
每次完成 API 设计任务后,回写经验到 ../field-journal/。
1 --- 2 name: skills-2 3 description: API 设计 Skills 总控 4 --- 5 # API 设计 Skills 总控 6 7 本目录收录 API 设计工作流的所有方法论 skills。 8 9 ## 当前 Skills 10 11 | Skill | 适用场景 | 来源 | 12 |-------|---------|------| 13 | [resource-modeling](resource-modeling/SKILL.md) | REST 资源建模 | REST 架构 + Roy Fielding | 14 | [endpoint-design](endpoint-design/SKILL.md) | 端点设计 | RFC 7231 / GitHub REST Guidelines | 15 | [request-response](request-response/SKILL.md) | 请求响应结构 | JSON:API / OpenAPI | 16 | [error-handling](error-handling/SKILL.md) | 错误码设计 | RFC 7807 Problem Details | 17 | [auth-permission](auth-permission/SKILL.md) | 认证鉴权 | OAuth 2.0 / RBAC | 18 | [pagination-filtering](pagination-filtering/SKILL.md) | 分页筛选排序 | Stripe / GitHub 风格 | 19 | [versioning](versioning/SKILL.md) | API 版本管理 | Stripe 版本策略 | 20 | [idempotency-retry](idempotency-retry/SKILL.md) | 幂等和重试 | Stripe Idempotency | 21 | [webhook-async](webhook-async/SKILL.md) | Webhook 和异步 | Stripe Webhooks / SVIX | 22 | [openapi-mock](openapi-mock/SKILL.md) | OpenAPI 契约和 Mock | OpenAPI 3.1 | 23 24 ## 统一入口 25 26 1. 先读 `routing.md` — 按 API 任务路由 27 2. 再进入对应 SKILL.md 28 3. 需要模板时进入 `<skill>/templates/` 29 30 ## 工作思路 31 32 skills 可以按需组合: 33 34 ```text 35 1. 拿到需求 → 先建模 36 - resource-modeling(资源建模) 37 38 2. 设计端点 → 列清单 39 - endpoint-design(端点设计) 40 - request-response(请求响应) 41 42 3. 处理错误和权限 43 - error-handling(错误码) 44 - auth-permission(认证鉴权) 45 46 4. 高级功能 47 - pagination-filtering(分页筛选) 48 - idempotency-retry(幂等重试) 49 - webhook-async(异步通信) 50 51 5. 输出和演进 52 - openapi-mock(OpenAPI + Mock) 53 - versioning(版本管理) 54 ``` 55 56 ## 新增 Skill 57 58 按 `CONTRIBUTING.md` 流程新增。 59 60 ## 自动进化 61 62 每次完成 API 设计任务后,回写经验到 `../field-journal/`。
zhaoxuya520/ai-fullstack-delivery-workflow/tree/main/workflows/api-designer/skills commit 5ba9d7cf83
Frequently asked questions How do I install the Skills skill? Run npx skillmds@latest add zhaoxuya520/skills-2 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 Skills skill do? API 设计 Skills 总控 It is listed under Integrations & APIs on SkillMD.
Is Skills 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 Skills? 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 Skills free to use? Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
Who published Skills? zhaoxuya520 (@zhaoxuya520) published this skill. Their other Agent Skills are listed on their SkillMD profile.