api-design

Design APIs that developers love to use.

Repositório: fabioc-aloha/Alex_Plug_In
Última atividade na origem: 15 de abril de 2026 às 05:03
Idioma detectado do SKILL.md: inglês
Estrelas: 5
Forks: 3

Opções de instalação

Por padrão, está selecionado o prompt que primeiro revisa a origem. Você pode mudar para um comando direto ou baixar uma cópia local.

Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.

Um comando direto ignora o prompt de revisão. Verifique a origem antes de executá-lo.

npx skills add https://github.com/fabioc-aloha/Alex_Plug_In --skill api-design

O comando permanece em uma só linha. Role horizontalmente para revisá-lo antes de copiar.

Prefere uma cópia local? Baixe os arquivos disponíveis atualmente no SkillsMP.

Revise os arquivos de origem

Leia o SKILL.md e os arquivos complementares exibidos pelo SkillsMP antes de decidir se vai instalar.

SKILL.md

Instruções da origem · Visualização somente leitura

Voltar à pesquisa Voltar à instalação

ascii-project-dashboard

Create and maintain ASCII visual dashboards for project tracking with parallel lane progress bars

2026-04-15

audio-memory

Store and manage voice samples for TTS cloning — portable, version-controlled audio references

2026-04-15

markdown-mermaid

Clear documentation through visual excellence

2026-04-15

Ver todas deste repositório

Code	Meaning	When to Use
200	OK	Successful GET, PUT, PATCH
201	Created	Successful POST
204	No Content	Successful DELETE
400	Bad Request	Validation error
401	Unauthorized	Missing authentication
403	Forbidden	Authenticated but not allowed
404	Not Found	Resource doesn't exist
409	Conflict	State conflict (duplicate)
429	Too Many Requests	Rate limited
500	Internal Error	Server bug

openapi: 3.0.3
info:
  title: My API
  version: 1.0.0
paths:
  /users:
    get:
      summary: List users
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'

GET /users?offset=40&limit=20
{ "data": [...], "pagination": { "total": 150 } }

GET /users?cursor=abc123&limit=20
{ "data": [...], "next_cursor": "def456" }

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": [{ "field": "email", "message": "Invalid format" }],
    "request_id": "req_abc123"
  }
}

Cache-Control: public, max-age=3600
Cache-Control: private, max-age=300
Cache-Control: no-store

GET /users/123
-> 200 OK, ETag: "v1-abc123"

GET /users/123, If-None-Match: "v1-abc123"
-> 304 Not Modified (or 200 with new ETag)

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1706792400

# When exceeded
429 Too Many Requests
Retry-After: 30

GET /users/123?fields=id,name,email

Good	Bad	Why
`/users`	`/getUsers`	Nouns, not verbs
`/users/123`	`/user?id=123`	Path params for identity
`/users/123/orders`	`/getUserOrders`	Hierarchical resources
`/search?q=term`	`/search/term`	Query params for filters

Good	Bad	Why
`/users`	`/getUsers`	Nouns, not verbs
`/users/123`	`/user?id=123`	Path params for identity
`/users/123/orders`	`/getUserOrders`	Hierarchical resources
`/search?q=term`	`/search/term`	Query params for filters

Strategy	Example	Recommendation
URL Path	`/v1/users`	Preferred - explicit
Header	`Accept: vnd.api.v1+json`	Clean but hidden
Query	`/users?version=1`	Avoid

Header	Purpose
`Cache-Control`	Caching directives
`ETag`	Content fingerprint
`Vary`	Cache key factors

Algorithm	Description
Fixed Window	X requests per minute
Token Bucket	Burst-friendly with refill
Sliding Window	Rolling time window

api-design

Opções de instalação

Revise os arquivos de origem

API Design Skill

Core Principle

REST Fundamentals

Resource Naming

HTTP Methods

API Design Skill

Core Principle

REST Fundamentals

Resource Naming

HTTP Methods

Status Codes

Contract-First Design

Versioning

Pagination Patterns

Offset-Based

Cursor-Based (Preferred for large datasets)

Error Response Design

Caching

HTTP Cache Headers

ETag Flow

Rate Limiting

Algorithms

Response Headers

Rate Limit Tiers

Request/Response Design

Partial Responses

Security Checklist

Documentation Requirements

API Review Checklist

Anti-Patterns

name	api-design
description	Design APIs that developers love to use.
tier	standard
applyTo	*/api,/rest,/endpoint,/route,/schema*

Tier	Limit	Use Case
Anonymous	60/hour	Public exploration
Authenticated	1000/hour	Normal usage
Premium	10000/hour	Power users

api-design

Informações da origem

Opções de instalação

Revise os arquivos de origem

Mais deste repositório

Mais deste repositório

API Design Skill

Core Principle

REST Fundamentals

Resource Naming

HTTP Methods

API Design Skill

Core Principle

REST Fundamentals

Resource Naming

HTTP Methods

Status Codes

Contract-First Design

Versioning

Pagination Patterns

Offset-Based

Cursor-Based (Preferred for large datasets)

Error Response Design

Caching

HTTP Cache Headers

ETag Flow

Rate Limiting

Algorithms

Response Headers

Rate Limit Tiers

Request/Response Design

Partial Responses

Security Checklist

Documentation Requirements

API Review Checklist

Anti-Patterns