api-and-interface-design
Design stable, well-documented, and evolvable APIs and interfaces (REST, GraphQL, internal modules, libraries). Use when creating or significantly changing public or internal APIs, contracts, or module boundaries.
- License 许可
- MIT
- 最近更新
- 2026-07-22
- Stars
- ★ 7
- Forks
- 1
01 前言 Front Matter
- name
- api-and-interface-design
- description
- Design stable, well-documented, and evolvable APIs and interfaces (REST, GraphQL, internal modules, libraries). Use when creating or significantly changing public or internal APIs, contracts, or module boundaries.
03 SKILL.md 正文
API and Interface Design
Overview
Good interfaces are hard to change later. Invest in clarity, consistency, and evolvability up front.
When to Use
- Designing new endpoints or services
- Changing existing public contracts
- Defining module or library boundaries
- Reviewing API proposals
Core Principles
- Clarity over cleverness
- Consistent naming and structure
- Explicit error models
- Backward compatibility as the default
- Documentation lives with the contract
Process
- Identify consumers and their needs
- Define resources/operations and their semantics
- Design request/response shapes and error cases
- Consider versioning and evolution strategy
- Document with examples
- Review for consistency with existing APIs
Checklist
- [ ] Resource naming is consistent and intuitive
- [ ] HTTP methods (or equivalent) used correctly
- [ ] Pagination, filtering, sorting considered where relevant
- [ ] Error responses are structured and actionable
- [ ] Authentication/authorization model is clear
- [ ] Breaking changes are avoided or explicitly versioned
- [ ] Examples are provided
Verification
- Contract is reviewable without reading implementation
- Common consumer scenarios are expressible cleanly
- Evolution path exists for likely future needs
04 同仓库更多 Skills
compliance-monitoring
Design compliance monitoring and testing programs that verify controls work in practice and surface issues before regulators do. Use when building monitoring plans, compliance testing, or continuous control monitoring.
complaints-handling
Operate complaints-handling processes that meet regulatory standards — logging, timely resolution, root-cause analysis, and fair outcomes. Use when designing or improving regulated complaints frameworks or analyzing complaint themes for conduct risk.
aml-kyc-basics
Apply AML/KYC fundamentals — customer due diligence, monitoring, suspicious activity escalation, and recordkeeping — for financial crime compliance. Use when designing onboarding controls, transaction monitoring concepts, or AML program components in financial services.
ai-model-compliance
Apply compliance controls to AI and automated decision systems — transparency, fairness, human oversight, documentation, and regulatory alignment. Use when deploying AI in regulated processes (credit, fraud, customer decisions) or responding to AI governance expectations.
data-quality-management
Manage data quality end-to-end — dimensions, rules, remediation, and prevention — beyond one-off cleaning scripts. Use when building sustained data quality programs or fixing systemic accuracy, completeness, or consistency problems.
data-lineage
Capture and use data lineage — where data comes from, how it transforms, and what depends on it — for impact analysis, debugging, and trust. Use when tracing metric origins, assessing change impact, or diagnosing broken pipelines.