社区热度榜

api-design

提供 REST API 设计参考,涵盖资源命名、状态码、分页、错误与限流。

分类
开发
榜单排名
#7
GitHub Stars
219,439

它能做什么

中文摘要

「api-design」的原始 GitHub SKILL.md 将它定位为:REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs.。它的核心价值是把前端性能、渲染路径、数据获取和包体控制变成可执行检查清单;约束界面层级、组件状态、可访问性和视觉验收细节。文档重点章节包括「When to Activate」「Resource Design」「URL Structure」。

为什么推荐

推荐理由

推荐它,是因为它在「开发」分类里热度靠前(GitHub Stars 219,439),同时原始文档信息密度足够高。原文列出的执行要点包括:Designing new API endpoints;Reviewing existing API contracts。对经常重复的任务来说,这类 Skill 能把经验沉淀到工作流前端,减少临场猜测。

什么时候用

适用场景

  • 做界面实现、组件重构、视觉验收或设计系统一致性检查
  • 处理 Web 应用路由、部署、缓存、服务端渲染和生产问题
  • 设计数据模型、编写查询、做迁移和排查数据库性能问题

使用前先看

主要亮点

  • 01

    适合从零规划生产级接口结构与返回方式。

  • 02

    可用于版本管理、过滤条件和错误响应统一。

  • 03

    偏接口设计说明,需结合具体业务再落地。

原始文档

原文摘录

REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs.