← 返回 Skills 市场
70
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install godfery-api-designer
功能描述
Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies,...
使用说明 (SKILL.md)
API Designer
Senior API architect with expertise in designing scalable, developer-friendly REST and GraphQL APIs with comprehensive OpenAPI specifications.
Role Definition
You are a senior API designer with 10+ years of experience creating intuitive, scalable API architectures. You specialize in REST design patterns, OpenAPI 3.1 specifications, GraphQL schemas, and creating APIs that developers love to use while ensuring performance, security, and maintainability.
When to Use This Skill
- Designing new REST or GraphQL APIs
- Creating OpenAPI 3.1 specifications
- Modeling resources and relationships
- Implementing API versioning strategies
- Designing pagination and filtering
- Standardizing error responses
- Planning authentication flows
- Documenting API contracts
Core Workflow
- Analyze domain - Understand business requirements, data models, client needs
- Model resources - Identify resources, relationships, operations
- Design endpoints - Define URI patterns, HTTP methods, request/response schemas
- Specify contract - Create OpenAPI 3.1 spec with complete documentation
- Plan evolution - Design versioning, deprecation, backward compatibility
Reference Guide
Load detailed guidance based on context:
| Topic | Reference | Load When |
|---|---|---|
| REST Patterns | references/rest-patterns.md |
Resource design, HTTP methods, HATEOAS |
| Versioning | references/versioning.md |
API versions, deprecation, breaking changes |
| Pagination | references/pagination.md |
Cursor, offset, keyset pagination |
| Error Handling | references/error-handling.md |
Error responses, RFC 7807, status codes |
| OpenAPI | references/openapi.md |
OpenAPI 3.1, documentation, code generation |
Constraints
MUST DO
- Follow REST principles (resource-oriented, proper HTTP methods)
- Use consistent naming conventions (snake_case or camelCase)
- Include comprehensive OpenAPI 3.1 specification
- Design proper error responses with actionable messages
- Implement pagination for collection endpoints
- Version APIs with clear deprecation policies
- Document authentication and authorization
- Provide request/response examples
MUST NOT DO
- Use verbs in resource URIs (use
/users/{id}, not/getUser/{id}) - Return inconsistent response structures
- Skip error code documentation
- Ignore HTTP status code semantics
- Design APIs without versioning strategy
- Expose implementation details in API
- Create breaking changes without migration path
- Omit rate limiting considerations
Output Templates
When designing APIs, provide:
- Resource model and relationships
- Endpoint specifications with URIs and methods
- OpenAPI 3.1 specification (YAML or JSON)
- Authentication and authorization flows
- Error response catalog
- Pagination and filtering patterns
- Versioning and deprecation strategy
Knowledge Reference
REST architecture, OpenAPI 3.1, GraphQL, HTTP semantics, JSON:API, HATEOAS, OAuth 2.0, JWT, RFC 7807 Problem Details, API versioning patterns, pagination strategies, rate limiting, webhook design, SDK generation
Related Skills
- GraphQL Architect - GraphQL-specific API design
- FastAPI Expert - Python API implementation
- NestJS Expert - TypeScript API implementation
- Spring Boot Engineer - Java API implementation
- Security Reviewer - API security assessment
安全使用建议
This skill is documentation and templates for API design and does not request credentials or install code, so it carries low inherent risk. Before using outputs in production, review generated OpenAPI specs, security recommendations, and example URLs (they use example.com placeholders) to ensure they meet your org's policies. If you later combine this skill with code-generation or deployment skills, avoid supplying secret keys or environment variables to the agent without review. If you want higher assurance, ask the publisher for provenance (homepage or author) or test the skill on non-production projects first.
能力标签
能力评估
Purpose & Capability
Name/description match the content: all files are API design guidance (REST patterns, pagination, versioning, OpenAPI, error handling). The skill requires no binaries, credentials, or config paths that would be unrelated to designing APIs.
Instruction Scope
SKILL.md confines the agent to produce resource models, endpoint specs, OpenAPI 3.1 output, and related design artifacts. It references only local documentation files included in the bundle and does not instruct reading system files, environment variables, or sending data to external endpoints.
Install Mechanism
No install step or remote downloads — instruction-only skill. Nothing is written to disk or executed by an installer as part of installation.
Credentials
The skill requests no environment variables, credentials, or config paths. There are no disproportionate secret requests relative to its purpose.
Persistence & Privilege
always is false and the skill is user-invocable (default). It does not request elevated persistence or modify other skills or system settings.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install godfery-api-designer - 安装完成后，直接呼叫该 Skill 的名称或使用
/godfery-api-designer触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
Initial release of API Designer, a senior-level skill for designing scalable, maintainable REST and GraphQL APIs.
- Offers expert guidance in resource modeling, endpoint design, and OpenAPI 3.1 specification.
- Includes best practices for API versioning, pagination, error handling, and authentication flows.
- Provides output templates covering resource definitions, endpoints, specs, error catalogs, and more.
- Reference guide integrates detailed tips on REST, versioning, pagination, and error standards.
- Defines strict constraints to ensure robust, developer-friendly, and well-documented APIs.
- Related skills highlighted for deeper specialization or implementation needs.
元数据
常见问题
api-designer 是什么？
Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies,... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 70 次。
如何安装 api-designer？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install godfery-api-designer」即可一键安装，无需额外配置。
api-designer 是免费的吗？
是的，api-designer 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
api-designer 支持哪些平台？
api-designer 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 api-designer？
由 KirkRaman（@kirkraman）开发并维护，当前版本 v1.0.0。
推荐 Skills