搜索

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 仓库 Stars0 仓库 Forks

安装与使用

请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。

查看来源 ↗使用指南

技能说明

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

使用示例

查看来源仓库中的使用示例与配置说明。

查看来源 ↗

来源历史

收录时间
2026-01-20
索引更新时间
2026-01-26
Branch
main

收录与同步日期属于本站记录。源码修改历史请查看来源仓库。

GitHub ↗

chat Comments (0)

chat_bubble_outline

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