feat(dev): 新增公开基线与专项设计 Skill
This commit is contained in:
@@ -0,0 +1,18 @@
|
||||
---
|
||||
name: design-api
|
||||
description: 基于项目需求、现有契约和对应版本官方规范设计或评审 HTTP API。适用于资源边界、方法、状态码、请求响应、兼容和 OpenAPI 契约;前后端字段对接、后端整体设计或直接编码不应触发。
|
||||
---
|
||||
|
||||
# API 设计
|
||||
|
||||
先确认项目协议、OpenAPI 版本、已有接口风格和兼容边界,再形成可实现、可验证的契约。
|
||||
|
||||
## 工作流
|
||||
|
||||
1. 读取 `.craftkit/project.json`、适用规范、现有契约和调用方证据。
|
||||
2. 明确资源、动作、幂等性、认证授权、输入、输出和错误语义。
|
||||
3. 方法、状态码、缓存、条件请求和重试语义以 [官方来源](references/sources.md) 及项目版本为依据。
|
||||
4. 输出路径与方法、参数位置、请求响应模型、错误、兼容、弃用和测试清单。
|
||||
5. 未确认的业务规则和框架封装列为待确认,不生成实现代码。
|
||||
|
||||
项目规则高于公共建议;不得默认最新 OpenAPI 版本或把内部接口模式写成通用规则。
|
||||
@@ -0,0 +1,4 @@
|
||||
interface:
|
||||
display_name: "API 设计"
|
||||
short_description: "设计和评审可验证的 HTTP API 契约"
|
||||
default_prompt: "使用 $design-api 为当前需求设计 HTTP API 契约。"
|
||||
@@ -0,0 +1,8 @@
|
||||
# 官方来源
|
||||
|
||||
重建日期:2026-08-25。
|
||||
|
||||
- HTTP Semantics,RFC 9110:https://www.rfc-editor.org/rfc/rfc9110.html
|
||||
- OpenAPI Specification: https://spec.openapis.org/oas/latest.html
|
||||
|
||||
RFC 9110 用于 HTTP 方法、状态和协议语义;OpenAPI 仅在项目采用的版本范围内用于契约表达。本文不复制规范正文,使用前应核对项目实际协议版本和官方勘误。IETF 文档受 IETF Trust 条款约束;OpenAPI 规范版权归 Linux Foundation,引用遵循其页面声明。
|
||||
Reference in New Issue
Block a user