Skip to content
Agentmart
Submit a tool
This entry duplicates api-and-interface-design, which is the one we list in search.

api-and-interface-design

Use for public APIs, schemas, events, config, or consumed module boundaries.

Skill by shiyuan17

IndexedMIT
Write a review

Install

Works with Claude Code, Claude apps, Codex, Cursor, Gemini CLI, GitHub Copilot, VS Code, OpenCode, Goose, Windsurf. Read the repository before you give any tool access to your data.

npx agentmarket install skill/shiyuan17-api-and-interface-design-29f690

Asks which of your tools to add it to (Claude Code, Codex, Cursor, VS Code, Windsurf, Gemini CLI, Claude Desktop) and shows the change first. See https://agentmart.dev/cli.

Get the weekly diff

The weekly diff: one email a week with new agent tools, notable updates and grade changes, plus security alerts for tools you follow. Double opt-in, one-click unsubscribe.

We use your email only for this newsletter. Privacy

About

Use for public APIs, schemas, events, config, or consumed module boundaries.

Use cases: design, backend

No reviews yet. Installed it? Reviews come from verified installers only. How reviews work

Permissions: not checked yet.

What's inside

Skill name
api-and-interface-design
Description
Use for public APIs, schemas, events, config, or consumed module boundaries.
License
MIT
Instructions
22 lines in SKILL.md · view on GitHub

Files (3)

  • SKILL.md
  • openai.yaml · agents/
  • metadata.json

SKILL.md (first lines)

# 设计接口契约

以现有契约和调用方为真值,先固定边界再实现。

同步归属:`docs/rules/api-rules.md`;两者描述同一契约,修改须同步。

## 执行

1. 找到契约来源、生产者、消费者和兼容窗口。
2. 明确输入、输出、错误、权限、可空性、分页、幂等、重试与并发冲突语义。
3. 在外部边界校验输入并限制大小与频率,保持内部类型可信;不要臆造字段或错误码。
4. 优先做可加的兼容演进;改名、改类型、改语义或收紧校验时设计迁移、弃用路径与回滚。
5. 同步 mapper、mock、文档和两侧契约测试。
6. 用真实调用路径证明生产者与消费者一致,不以单侧测试替代。

契约来源、owner、兼容性或迁移决定未定时,暂停依赖该决定的实现,列出缺口并继续可独立核验的部分;未完成两侧验证时不得声称集成通过。

## 交付

报告契约来源、兼容影响、迁移方式、两侧验证和剩余未决项。

From shiyuan17/Vibe-Harness, MIT.

More from shiyuan17/Vibe-Harness

Signals

Stars
0
Forks
0
Open issues
0
Last commit (this folder)
Oct 14, 2026 (15 days ago)

From GitHub (fetched Oct 24, 2026).

Details

License
MIT
First seen
Oct 24, 2026
Last checked
Oct 24, 2026

Same skill elsewhere

Copies of this SKILL.md published by others; search shows only one of them.

More from shiyuan17

Cite this page

api-and-interface-design skill. Agent Mart. https://agentmart.dev/skills/shiyuan17-api-and-interface-design-29f690 (last updated 2026-10-24)