api-protocol

Community

Standardize Sunrei API development.

Authoryongseongkim
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill provides a clear and consistent set of guidelines for developing API endpoints within the Sunrei project, ensuring uniformity in naming conventions, HTTP methods, and response structures.

Core Features & Use Cases

  • Standardized Naming: Defines conventions for request and response types (e.g., GetUserParams, ListUsersResult).
  • HTTP Method Rules: Outlines the appropriate use of GET, POST, PUT, PATCH, and DELETE for CRUD operations.
  • Response Formatting: Specifies consistent formats for success, error, and paginated responses.
  • Use Case: When developing a new API endpoint for managing user profiles, consult this guide to ensure the endpoint adheres to the established api-protocol for naming, method usage, and response structure.

Quick Start

Follow the api-protocol guide when defining new API endpoints for the Sunrei project.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-protocol
Download link: https://github.com/yongseongkim/sunrei/archive/main.zip#api-protocol

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.