api-protocol

Document the Sunrei API protocol with RESTful principles and OpenAPI 3.0 specifications.

Updated Jul 1, 2024
One-click install
npx skills add https://github.com/yongseongkim/sunrei --skill api-protocol
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-protocol
Source: https://github.com/yongseongkim/sunrei/tree/main/.claude/skills/api-protocol
Command: npx skills add https://github.com/yongseongkim/sunrei --skill api-protocol

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about api-protocol

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are RESTful API naming conventions for request and response types?

Standardize Sunrei API development by following RESTful principles and OpenAPI 3.0 specifications. This guide details naming conventions for request and response types, rules for HTTP method usage, and standard response formats for success, errors, and pagination.

How do I structure success, error, and pagination responses in OpenAPI 3.0?

Structure success, error, and pagination responses in OpenAPI 3.0 by adhering to the api-protocol standard response formats. This ensures consistent API response structures across all endpoints for success, errors, and pagination.

When should I use PATCH vs PUT for RESTful API CRUD operations?

Use PATCH vs PUT for RESTful API CRUD operations based on the api-protocol HTTP method rules. The guide outlines appropriate use of GET, POST, PUT, PATCH, and DELETE to ensure consistency and maintainability across API endpoints.

Does this API protocol guide support standardizing endpoint development for the Sunrei project?

Yes, this API protocol guide supports standardizing endpoint development for the Sunrei project. It provides a clear set of guidelines for naming conventions, HTTP methods, and response structures to ensure uniformity in API development.

What is the best way to maintain consistency across new API endpoints?

The best way to maintain consistency across new API endpoints is to follow a standardized api-protocol guide. It defines naming conventions, HTTP method rules, and response formatting to ensure uniformity and maintainability across the project.