api-contract

当用户询问“API合同”、“api-contract.md”、“共享接口”、“TypeScript接口”、“请求/响应模式”、“端点设计”或需要指导设计协调后端和前端代理的合同时使用此技能。在构建或修改API端点时使用。通过“创建API”、“设计端点”或“API脚手架”等短语触发。

📖 中文导读:当用户询问“API合同”、“api-contract.md”、“共享接口”、“TypeScript接口”、“请求/响应模式”、“端点设计”或需要指导设计协调后端和前端代理的合同时使用此技能。在构建或修改API端点时使用。通过“创建API”、“设计端点”或“API脚手架”等短语触发。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: api-contract description: | Configure this skill should be used when the user asks about "API contract", "api-contract.md", "shared interface", "TypeScript interfaces", "request response schemas", "endpoint design", or needs guidance on designing contracts that coordinate backend and frontend agents. Use when building or modifying API endpoints. Trigger with phrases like 'create API', 'design endpoint', or 'API scaffold'. allowed-tools: Read version: 1.0.0 author: Damien Laine damien.laine@gmail.com license: MIT

Api Contract

Overview

This skill provides automated assistance for the described functionality.

Prerequisites

  • Appropriate file access permissions
  • Required dependencies installed

Instructions

  1. Invoke this skill when the trigger conditions are met
  2. Provide necessary context and parameters
  3. Review the generated output
  4. Apply modifications as needed

Output

The skill produces structured output relevant to the task.

Error Handling

See {baseDir}/references/errors.md for comprehensive error handling.

Examples

See {baseDir}/references/examples.md for detailed examples.

Resources

  • Project documentation
  • Related skills and commands