Back to Details

versioning-apis

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Versioning Apis

API版本控制

Overview

概述

This skill provides automated assistance for api versioning manager tasks. This skill provides automated assistance for the described functionality.

本技能可为API版本管理任务提供自动化协助。本技能可为上述功能提供自动化协助。

Prerequisites

前置条件

Before using this skill, ensure you have:

API design specifications or requirements documented
Development environment with necessary frameworks installed
Database or backend services accessible for integration
Authentication and authorization strategies defined
Testing tools and environments configured

使用本技能前，请确保您已具备：

已记录的API设计规范或需求
安装了必要框架的开发环境
可用于集成的数据库或后端服务
已定义的身份验证与授权策略
已配置的测试工具和环境

Instructions

操作步骤

Use Read tool to examine existing API specifications from {baseDir}/api-specs/
Define resource models, endpoints, and HTTP methods
Document request/response schemas and data types
Identify authentication and authorization requirements
Plan error handling and validation strategies
Generate boilerplate code using Bash(api:version-*) with framework scaffolding
Implement endpoint handlers with business logic
Add input validation and schema enforcement
Integrate authentication and authorization middleware
Configure database connections and ORM models
Write integration tests covering all endpoints

See

{baseDir}/references/implementation.md

for detailed implementation guide.

使用Read工具查看
```
{baseDir}/api-specs/
```
中的现有API规范
定义资源模型、端点和HTTP方法
记录请求/响应模式及数据类型
明确身份验证与授权要求
规划错误处理和验证策略
使用Bash(api:version-*)结合框架脚手架生成样板代码
实现包含业务逻辑的端点处理器
添加输入验证和模式校验
集成身份验证与授权中间件
配置数据库连接和ORM模型
编写覆盖所有端点的集成测试

请查看

{baseDir}/references/implementation.md

获取详细的实现指南。

Output

输出内容

```
{baseDir}/src/routes/
```
- Endpoint route definitions
```
{baseDir}/src/controllers/
```
- Business logic handlers
```
{baseDir}/src/models/
```
- Data models and schemas
```
{baseDir}/src/middleware/
```
- Authentication, validation, logging
```
{baseDir}/src/config/
```
- Configuration and environment variables
OpenAPI 3.0 specification with complete endpoint definitions

```
{baseDir}/src/routes/
```
- 端点路由定义
```
{baseDir}/src/controllers/
```
- 业务逻辑处理器
```
{baseDir}/src/models/
```
- 数据模型和模式
```
{baseDir}/src/middleware/
```
- 身份验证、验证、日志记录组件
```
{baseDir}/src/config/
```
- 配置和环境变量
包含完整端点定义的OpenAPI 3.0规范

Error Handling

错误处理

See

{baseDir}/references/errors.md

for comprehensive error handling.

请查看

{baseDir}/references/errors.md

获取全面的错误处理指南。

Examples

示例

See

{baseDir}/references/examples.md

for detailed examples.

请查看

{baseDir}/references/examples.md

获取详细示例。

Resources

参考资源

Express.js and Fastify for Node.js APIs
Flask and FastAPI for Python APIs
Spring Boot for Java APIs
Gin and Echo for Go APIs
OpenAPI Specification 3.0+ for API documentation

Express.js和Fastify（适用于Node.js API）
Flask和FastAPI（适用于Python API）
Spring Boot（适用于Java API）
Gin和Echo（适用于Go API）
OpenAPI Specification 3.0+（用于API文档）