跳到正文
cccskills
免费在 GitHub 公开

api-designer

Helps plan REST and GraphQL APIs by modeling resources, defining endpoints and request or response schemas, and documenting the contract in OpenAPI 3.1. It also covers pagination, error formats, authentication, versioning, and deprecation planning.

中文简介正在准备中。当前显示英语简介。

原文查看原文说明

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.

sundial-org/awesome-openclaw-skills星标 671(GitHub 671 + cccskills 0)

实测评分 未实测

查看安装方法

适用场景

  • Designing a new REST API and its resources
  • Drafting a GraphQL schema and API contract
  • Creating an OpenAPI 3.1 specification
  • Planning pagination, errors, and API versioning

包含的文件(6)

  • SKILL.md3.8 KB
  • references/error-handling.md11.3 KB
  • references/openapi.md16.0 KB
  • references/pagination.md9.4 KB
  • references/rest-patterns.md7.3 KB
  • references/versioning.md7.8 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

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

  1. Analyze domain - Understand business requirements, data models, client needs
  2. Model resources - Identify resources, relationships, operations
  3. Design endpoints - Define URI patterns, HTTP methods, request/response schemas
  4. Specify contract - Create OpenAPI 3.1 spec with complete documentation
  5. Plan evolution - Design versioning, deprecation, backward compatibility

Reference Guide

Load detailed guidance based on context:

TopicReferenceLoad When
REST Patternsreferences/rest-patterns.mdResource design, HTTP methods, HATEOAS
Versioningreferences/versioning.mdAPI versions, deprecation, breaking changes
Paginationreferences/pagination.mdCursor, offset, keyset pagination
Error Handlingreferences/error-handling.mdError responses, RFC 7807, status codes
OpenAPIreferences/openapi.mdOpenAPI 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:

  1. Resource model and relationships
  2. Endpoint specifications with URIs and methods
  3. OpenAPI 3.1 specification (YAML or JSON)
  4. Authentication and authorization flows
  5. Error response catalog
  6. Pagination and filtering patterns
  7. 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

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

1password

免费

Set up and use the 1Password command-line tool `op` to sign in, verify account access, and work with vault data. The skill covers single or multiple accounts and shows how to run commands or fill templates with secrets while limiting exposure in logs and files.

中文简介正在准备中。当前显示英语简介。

  • Set up the `op` command-line tool
  • Sign in and verify access to an account
  • Run a command with vault secrets
sundial-org/awesome-openclaw-skills6712026年3月7日 更新

Check live prices, price changes, and trading volume for Shanghai, Shenzhen, and Beijing stocks. Review intraday volume patterns and possible large-investor activity, and manage holdings with cost, quantity, and profit or loss summaries.

中文简介正在准备中。当前显示英语简介。

  • Checking current prices for A-share stocks
  • Reviewing intraday volume and large-investor signals
  • Managing a stock portfolio and checking profit or loss
sundial-org/awesome-openclaw-skills6712026年3月7日 更新

Scan HTML or JSX files and directories for accessibility issues such as missing image descriptions, form labels, and keyboard access problems. The skill identifies WCAG guideline failures and provides suggested code fixes alongside its findings.

中文简介正在准备中。当前显示英语简介。

  • Checking a new component before release
  • Auditing an inherited codebase
  • Preparing for an accessibility compliance review
sundial-org/awesome-openclaw-skills6712026年3月7日 更新

Plan A/B tests that compare page or product changes, with clear hypotheses, sample sizes, success metrics, and traffic allocation. Get a structured test plan and guidance for interpreting results and deciding what to try next.

中文简介正在准备中。当前显示英语简介。

  • Comparing signup button copy
  • Planning a pricing page experiment
  • Estimating sample size and test duration
sundial-org/awesome-openclaw-skills6712026年3月7日 更新

Turn LinkedIn profile URLs into coordinated account-based outreach. The workflow gathers profile details, enriches contacts with email and phone data, looks up mailing addresses, and prepares email, LinkedIn, and handwritten-letter touches with the specified services.

中文简介正在准备中。当前显示英语简介。

  • Building a multichannel campaign from LinkedIn prospect URLs
  • Enriching prospect records with work contact details
  • Coordinating email, LinkedIn, and handwritten mail outreach
sundial-org/awesome-openclaw-skills6712026年3月7日 更新

accli

免费

Work with Apple Calendar on macOS to list calendars, find and view events, and check busy time slots across calendars. Create, update, or delete events with details such as dates, locations, and descriptions.

中文简介正在准备中。当前显示英语简介。

  • Reviewing events on a work or personal calendar
  • Checking availability before scheduling a meeting
  • Creating or updating a calendar event
sundial-org/awesome-openclaw-skills6712026年3月7日 更新

查看 sundial-org 的全部技能

报告此技能的问题