Agent skill

api-protocol

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

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/api-protocol

SKILL.md

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": "..." }

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results