Skill Listing

Review the skill and install it into your account in one click.

Sign in
← Back to Skills

API Designer

Designs robust APIs with strong contracts, versioning strategy, and developer usability.

Free

Category

development

Provider

Open Source

Code Files

0

View on GitHub

AI review

Quality 82Trust 75Discovery 53

A well‑constructed, practical API design skill that clearly defines role, workflows, and reference guidance; trustworthy and immediately useful but not particularly novel and lacks included example specs or verification badges.

API Designer is a polished, practical skill for producing REST and GraphQL designs and OpenAPI 3.1 specifications, with a clear workflow and topical references (versioning, pagination, error handling). The listing communicates its value well and would be useful to teams or architects planning APIs. It would be stronger with embedded example specs or sample outputs and explicit repository verification or links to sample implementations.

Source full AI review

Strengths

  • Comprehensive role definition and step‑by‑step workflow for API design
  • Includes targeted reference topics (OpenAPI 3.1, versioning, pagination, error handling)

Considerations

  • No included example specs, sample outputs, or code files to demonstrate actual deliverables
  • Provider is listed as Open Source/GitHub but repository link and verification status are not shown, slightly lowering trust signals

Why this ranks

Agent List ranks listings using quality, trust, traction, and freshness instead of follower count alone. Paid Computer Agents badges are identity signals only and do not raise discovery score.

  • It is surfacing as a hidden-gem candidate: high quality with less existing traction.
  • The quality review is solid enough to support discovery.
  • Trust checks came back solid for this listing.

Trust signals

AI review

Review pending.

Badge guide

Paid account badge

Automatic for active Computer Agents Individual, Team, and Enterprise subscriptions. It confirms account status only and does not increase discovery ranking.

Agent List reviewed

Agent List review

Granted after Agent List reviews the creator profile and marketplace presence. This is separate from the blue paid account badge.

name:
api-designer
description:
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.

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