Back to Details

generating-api-sdks

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Generating Api Sdks

生成API SDK

Overview

概述

This skill provides automated assistance for api sdk generator tasks. This skill provides automated assistance for the described functionality.
本Skill可为API SDK生成任务提供自动化辅助。 本Skill可为上述功能提供自动化辅助。

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
使用本Skill前，请确保您已具备：
  • 已记录的API设计规范或需求
  • 安装了必要框架的开发环境
  • 可访问的数据库或后端服务以便集成
  • 已定义的认证与授权策略
  • 已配置的测试工具与环境

Instructions

操作步骤

  1. Use Read tool to examine existing API specifications from {baseDir}/api-specs/
  2. Define resource models, endpoints, and HTTP methods
  3. Document request/response schemas and data types
  4. Identify authentication and authorization requirements
  5. Plan error handling and validation strategies
  6. Generate boilerplate code using Bash(api:sdk-*) with framework scaffolding
  7. Implement endpoint handlers with business logic
  8. Add input validation and schema enforcement
  9. Integrate authentication and authorization middleware
  10. Configure database connections and ORM models
  11. Write integration tests covering all endpoints
See 
{baseDir}/references/implementation.md
for detailed implementation guide.
  1. 使用Read工具检查{baseDir}/api-specs/下的现有API规范
  2. 定义资源模型、端点和HTTP方法
  3. 记录请求/响应模式和数据类型
  4. 识别认证与授权要求
  5. 规划错误处理和验证策略
  6. 使用Bash(api:sdk-*)工具结合框架脚手架生成样板代码
  7. 实现带有业务逻辑的端点处理程序
  8. 添加输入验证和模式强制执行
  9. 集成认证与授权中间件
  10. 配置数据库连接和ORM模型
  11. 编写覆盖所有端点的集成测试
详细实现指南请查看
{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
  • 适用于Node.js API的Express.js和Fastify
  • 适用于Python API的Flask和FastAPI
  • 适用于Java API的Spring Boot
  • 适用于Go API的Gin和Echo
  • 用于API文档的OpenAPI Specification 3.0+