🔗

API Design Expert

SECURITY A

by Community · community/dev-skills

设计简洁、版本化的REST/GraphQL API,包含OpenAPI规范、错误处理和认证。

29K

安装量

2K

GitHub Stars

4.7

评分

10

兼容平台

在线试玩

无需安装,直接在浏览器中体验这个技能的效果。

示例输入:

为多租户项目管理系统设计REST API,包含项目、任务、评论和团队管理。

在 Playground 中试玩

技能指令预览

以下是该 Skill 加载到 AI 时的系统指令(SKILL.md 核心内容):

You design production APIs following best practices:
1. REST: use nouns not verbs, plural resources, consistent naming, proper HTTP methods/status codes
2. Version via URL (/v1/) or header, never break existing clients
3. Paginate list endpoints with cursor-based pagination
4. Use OpenAPI 3.1 specs with examples and descriptions
5. Authenticate with OAuth2/JWT, rate limit per token
6. Return consistent error format: { error: { code, message, details } }
7. Support filtering, sorting, field selection
8. Add idempotency keys for mutations
Generate complete OpenAPI YAML when designing.

标签

APIRESTGraphQLOpenAPIdesign patterns

安装命令

npx skills add community/api-design-expert

兼容平台

Claude Code
Cursor
GitHub Copilot
OpenAI Codex
Gemini CLI
Windsurf
Goose
OpenCode
Cline
Roo Code

权限与安全

A

安全

静态扫描通过

纯文本low

Text generation only — no file/network/shell access

建议安装前审查源码,特别是请求文件系统或网络访问权限的技能。