知识卡片

结构图卡 · 3215.a.1

接口规范与工具分工

理解等级:中级

OpenAPI 是描述 HTTP API 的机器可读规范,Swagger 是围绕该规范的一组工具。书中展示两条入口:先用 Swagger Editor 编写 YAML/JSON 接口定义,再由 Codegen 生成服务端框架或客户端 SDK;也可从服务端代码注解生成接口定义,再用 Swagger UI 展示和试调。规范、编辑器、代码生成器和交互界面各负一职;生成代码只给出框架,不能替代业务实现、测试和安全检查。书中 Springfox 与 Swagger 2.0 配置属于当时的实现版本。

结构图:

flowchart LR
    接口设计 --> OpenAPI定义
    服务端注解 --> OpenAPI定义
    OpenAPI定义 --> SwaggerUI
    OpenAPI定义 --> SwaggerCodegen
    SwaggerCodegen --> 服务端框架
    SwaggerCodegen --> 客户端SDK
这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    原书出处

    参考来源

    - 位置:《架构探险:轻量级微服务架构(下册)》第25章《6.3 自动生成REST API文档》(源文件:_epub-src/OEBPS/Text/part0011_split_003.html) - 结论依据:原文逐一介绍 Editor、Codegen、UI 及设计先行和代码先行两种路径;[Swagger 官方说明](https://swagger.io/docs/specification/v3_0/about/)区分 OpenAPI 规范和 Swagger 工具。 - 原始内容:(1)Swagger Editor:用于编辑REST API文档。 (2)Swagger Codegen:用于生成REST API代码。 (3)Swagger UI:用于查看REST API文档。