功能描述

Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.

使用说明 (SKILL.md)

API Designer

Name: Api Designer
Author: veeramanikandanr48

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 appears coherent and low-risk: it only contains design guidance and templates and requests no credentials or installs. Before relying on generated specs in production, review them for correctness, security (auth/rate-limiting), and any organization-specific conventions. Because the package source/homepage is unknown, avoid pasting real secrets or production credentials into prompts and validate outputs against your internal security and API governance standards. If you need provenance, ask the publisher for a homepage, license, or authorship information before wider deployment.

功能分析

Type: OpenClaw Skill Name: api-designer Version: 0.1.0 The skill bundle is a comprehensive knowledge base for an AI agent focused on API design. All files, including the SKILL.md and various reference markdown documents, contain only informational content, best practices, and examples related to REST/GraphQL API design, OpenAPI specifications, error handling, pagination, and versioning. There is no evidence of prompt injection attempts against the agent, data exfiltration, malicious execution, or any other harmful behavior. The example CLI commands in `references/openapi.md` are for user information and are not instructions for the agent to execute, nor are they inherently malicious.

能力评估

✓ Purpose & Capability

Name, description, SKILL.md, and the included reference docs (OpenAPI, pagination, versioning, error handling, REST patterns) are coherent and directly relevant to designing REST/GraphQL APIs and producing OpenAPI specs.

✓ Instruction Scope

Runtime instructions are limited to API-design activities (resource modeling, spec generation, versioning, pagination, error handling). They do not instruct reading system files, environment variables, or contacting external endpoints beyond normal documentation examples.

✓ Install Mechanism

No install spec and no code files that would be written to disk; lowest-risk instruction-only skill.

✓ Credentials

The skill does not declare or require any environment variables, credentials, or config paths; requested capabilities are proportionate to an API design assistant.

✓ Persistence & Privilege

always:false and no special privileges or hints of modifying other skills or system settings. Autonomous invocation is allowed (platform default) but is not combined with other risky privileges.

版本历史

v0.1.0

Initial release of api-designer skill: - Provides expert guidance for designing REST and GraphQL APIs, including OpenAPI 3.1 specifications. - Covers resource modeling, endpoint design, error handling, versioning, pagination, and authentication. - Includes detailed reference guides and mandatory design constraints. - Outputs comprehensive API specifications, documentation templates, and best practices.

元数据

Slug api-designer

版本 0.1.0

许可证 —

累计安装 23

当前安装数 22

历史版本数 1

常见问题

Api Designer 是什么？

Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 3627 次。

如何安装 Api Designer？

在 OpenClaw 或 Claude Code 对话框中运行命令「/install api-designer」即可一键安装，无需额外配置。

Api Designer 是免费的吗？

是的，Api Designer 完全免费（开源免费），可自由下载、安装和使用。

Api Designer 支持哪些平台？

Api Designer 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。

谁开发了 Api Designer？

由 Veera（@veeramanikandanr48）开发并维护，当前版本 v0.1.0。

Api Designer