SuperAPI AI 工具集

openapi-rpc-workflow

编程与开发

查看项目

更新于 10-15 21:49

技能介绍

用途:构建或诊断契约优先的 Swift 服务端工作。资料强调区分三件事:OpenAPI 描述是 HTTP API 契约;Swift OpenAPI Generator 从契约生成 Swift 类型、客户端调用和服务端协议桩;服务器传输层(OpenAPIHummingbird 或 OpenAPIVapor)把生成的 APIProtocol 实现注册到真实的 Hummingbird 或 Vapor 应用。

主要能力:在 Swift 包中添加、编辑、校验、消费 OpenAPI 文档;把生成器接入 Package.swift、openapi-generator-config.yaml、生成源码或 SwiftPM 插件命令;用 APIProtocol、Operations、Components、OpenAPIRuntime 实现生成的服务器桩;在 Hummingbird 与 Vapor 之间选择传输层;诊断生成代码漂移、operation ID 变更、缺失 schema、请求响应类型、传输注册或校验失败。

RPC 判断:先确认是 OpenAPI 支持的 HTTP 操作、HTTP 上的 JSON-RPC、gRPC、MCP 风格工具调用,还是框架专属契约;协议选择必须显式,服务不需要更强契约时默认普通 HTTP 路由。

使用方式:检查项目形态(Package.swift、OpenAPI 文档、生成器配置、目标、框架路由注册、生成名称);确认契约归属与生成器栈;校验顺序为规范有效性、生成与构建、服务端注册测试、必要时运行时 HTTP 检查。Hummingbird 侧构建 Router、实现 APIProtocol、调用注册、走既有生命周期;Vapor 侧创建 VaporTransport、注册处理器、走既有运行命令。测试优先跑最小 SwiftPM 命令(如 swift build 或 swift test),curl 仅用于无法由测试证明的运行时行为。

限制:不要用于无生成契约的通用 Vapor 或 Hummingbird 路由;不要用于 Apple 平台应用、模拟器、预览或 Xcode 工程成员工作。不要用 OpenAPITools CLI 替代 Apple 插件;不要提交本机依赖路径、生成缓存、密钥或凭据;不要静默重命名 operation ID 或共享 schema;不要随意添加请求注入、任务本地上下文、gRPC、protobuf 或 MCP 运行时依赖;生成处理器不应承载无关业务规则。