Search

PythonReactSEOPDF
GitHub Skill

api-design

Provides API design guidelines for REST, GraphQL, versioning, logging, observability, and architecture patterns. Use when designing APIs, reviewing architecture, implementing microservices, or setting up monitoring.

kcenon☆ 2 Repository stars0 Repository forks

Installation

Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.

View source ↗Guides

Skill instructions

API Design Skill

When to Use

  • Designing REST or GraphQL APIs
  • Architecture and microservices design
  • Setting up logging and observability
  • Implementing rate limiting or authentication
  • Code review for API endpoints

Reference Documents (Import Syntax)

API Design

@./reference/api-design.md

Architecture

@./reference/architecture.md

Observability

@./reference/logging.md @./reference/observability.md

Core Principles

  1. RESTful conventions: Use proper HTTP methods and status codes
  2. SOLID principles: Apply design patterns appropriately
  3. Structured logging: Include context and correlation IDs
  4. Observability: Implement metrics, traces, and health checks

Examples

Read the usage examples in the source repository.

View source ↗

Source history

Indexed on
2026-01-20
Index updated
2026-01-26
Branch
main

Index and sync dates describe this directory. View the source repository for code history.

GitHub ↗

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!