api-design | pokayokay | ClaudePluginHub

Skill

Community

api-design

2

Description

Use when designing new REST APIs, reviewing API designs, establishing API standards, designing request/response formats, pagination, versioning, authentication flows, or creating OpenAPI specifications.

AI Summary

Designs REST APIs with consistent patterns, OpenAPI specifications, and developer-friendly contracts.

Install

1

Add the repository(one-time)

$

/plugin marketplace add srstomp/pokayokay

2

Install the plugin

$

/plugin install pokayokay@pokayokay

Tool Access

This skill inherits all available tools. When active, it can use any tool Claude has access to.

Supporting Assets

View in Repository

references/endpoints.md

references/openapi.md

references/pagination-filtering.md

references/requests-responses.md

references/review-checklist.md

references/security.md

references/status-codes.md

references/tdd-patterns.md

references/versioning.md

Skill Content

API Design

Design clear, consistent, and developer-friendly REST APIs.

When NOT to Use

Consuming external APIs — Use api-integration for building clients to call third-party services (Stripe, Twilio, etc.)
Writing tests for APIs — Use testing-strategy for contract tests, integration tests, mocking strategies
Reviewing existing API security — Use security-audit for vulnerability scanning of live endpoints
Designing auth mechanisms that are the whole task — Use security-audit if reviewing, this skill if designing from scratch

Core Principles

Resource-oriented — Design around nouns (resources), not verbs (actions)
Predictable patterns — Consistent URL structure, response format, and behavior
Clear contracts — Explicit schemas, documented errors, versioned endpoints
Developer experience — Meaningful errors, helpful examples, logical defaults

Quick Start Checklist

Identify resources and their relationships
Define CRUD operations + custom actions with correct HTTP methods
Design request/response schemas with consistent envelope
Plan error format with status codes, error codes, and field-level details
Write OpenAPI specification with examples
Review for consistency, security, and usability

Design Quick Reference

Method	Purpose	Idempotent	Body
GET	Read	Yes	No
POST	Create	No	Yes
PUT	Replace	Yes	Yes
PATCH	Partial update	Yes*	Yes
DELETE	Remove	Yes	No

References

Reference	Description
endpoints.md	URL design, HTTP methods, resource modeling
requests-responses.md	Request/response formats, headers, content types
status-codes.md	HTTP status codes, error handling patterns
pagination-filtering.md	Pagination, filtering, sorting, searching
versioning.md	API versioning strategies
openapi.md	OpenAPI specification, documentation
security.md	Authentication, authorization, rate limiting
tdd-patterns.md	Test-first patterns for REST endpoints, supertest templates
review-checklist.md	API design review checklist (validation, auth, performance, docs)

Links

GitHub Stats

0 forks

Updated 28 days ago

Actions

Similar Skills

Activates when the user asks about AI prompts, needs prompt templates, wants to search for prompts, or mentions prompts.chat. Use for discovering, retrieving, and improving prompts.

149.6k

Search, retrieve, and install Agent Skills from the prompts.chat registry using MCP tools. Use when the user asks to find skills, browse skill catalogs, install a skill for Claude, or extend Claude's capabilities with reusable AI agent components.

149.6k

algorithmic-art

Creating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems. Create original algorithmic art rather than copying existing artists' work to avoid copyright violations.

anthropic-skills

84.5k