addyosmani/agent-skills✦ 精选0°

api-and-interface-design

仓库创建 2026年2月16日最近提交 21 小时前SkillHot 收录 20 天前

⬈ GitHub 仓库 ⬈ SKILL.md 原文件 ⬇ Raw 原始文件

▸ 精选理由

提供工程化的接口设计原则，适合定义模块与后端边界。

这个 Skill 做什么

为REST/GraphQL等设计稳定且易用的接口规范。

帮你设计稳定、好用且不易被误用的接口，涵盖 REST、GraphQL、模块边界或前后端契约等场景。新建 API、定义类型合约或划分模块责任时用，目标是让正确的用法变简单、错误的用法变难。优势在于把复杂交互抽象成易懂、可维护的接口规范。

▸ 展开 SKILL.md 英文原文

Guides stable API and interface design. Use when designing APIs, module boundaries, or any public interface. Use when creating REST or GraphQL endpoints, defining type contracts between modules, or establishing boundaries between frontend and backend.

开发编程API设计接口契约设计规范通用

8.1w

Stars

8.7k

Forks

仓库内 Skill

+10.0k

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/addyosmani/agent-skills/main/skills/api-and-interface-design/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/addyosmani/agent-skills/main/skills/api-and-interface-design/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# API and Interface Design

## Overview

Design stable, well-documented interfaces that are hard to misuse. Good interfaces make the right thing easy and the wrong thing hard. This applies to REST APIs, GraphQL schemas, module boundaries, component props, and any surface where one piece of code talks to another.

## When to Use

- Designing new API endpoints
- Defining module boundaries or contracts between teams
- Creating component prop interfaces
- Establishing database schema that informs API shape
- Changing existing public interfaces

## Core Principles

### Hyrum's Law

> With a sufficient number of users of an API, all observable behaviors of your system will be depended on by somebo

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有