Claude-skill-registry api-protocol

API protocol guide for Sunrei project. Use when writing API endpoints, request/response type naming, and HTTP method conventions.

install
source · Clone the upstream repo
git clone https://github.com/majiayu000/claude-skill-registry
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/majiayu000/claude-skill-registry "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/data/api-protocol" ~/.claude/skills/majiayu000-claude-skill-registry-api-protocol && rm -rf "$T"
manifest: skills/data/api-protocol/SKILL.md
source content

API Protocol Guide

RESTful API + OpenAPI 3.0 spec

  • Request type:
    {HttpMethod}{Name}Params
    (e.g.,
    GetUserParams
    ,
    ListUsersParams
    )
  • Response type:
    {HttpMethod}{Name}Result
    (e.g.,
    GetUserResult
    ,
    ListUsersResult
    )

HTTP Method Rules

  • GET
    + singular → single item (e.g.,
    GET /sunreis/{id}
    )
  • List
    + plural → list items (e.g.,
    GET /sunreis
    )
  • POST
    → create
  • PUT
    → full update
  • PATCH
    → partial update
  • DELETE
    → delete

Response Format

  • Success:
    { "data": ... }
    or domain key (e.g.,
    { "sunreis": [...] }
    )
  • Error:
    { "error": { "code": "...", "message": "..." } }
  • Pagination:
    { "items": [...], "nextToken": "..." }