在往期的文章中,我们对 OpenAPI 规范有了一个基本的了解,接下来的几篇文章,我们会通过一个实际应用场景,编写一个完整的 OpenAPI 文档。
工欲善其事,必先利其器。今天我们先来搭建文档编写的环境。
OpenAPI 文档是一个纯文本文档,不管是 JSON 格式,还是 YAML 格式。同时,纯文本文件也有利于存储和版本化管理。你可以使用自己喜欢的文本编辑器,但是,为了提高效率,避免不必要的语法错误,我们还是建议使用较为专业的文本编辑器。
下面,我们就介绍如何使用 Visual Studio Code 建立 OpenAPI 文档开发环境。
安装 Visual Studio Code
如果你已经安装过 Visual Studio Code 了,可以忽略本节。
Visual Studio Code 是一款免费、开源、跨平台的轻量级开发工具。通过安装和配置不同的插件,可以支持不同语言的开发。
访问官方网站,根据所使用的操作系统,下载对应版本的软件。
运行软件安装包,按默认提示安装即可。
安装 OpenAPI 插件
新安装的 Visual Studio Code 只具备基本、通用的开发能力,如果要针对特定语言或平台开发,需要安装相应的插件。下面我们就安装支持 OpenAPI 文档编写的插件:OpenAPI (Swagger) Editor.
- 打开 Visual Studio Code,点击左侧活动栏的扩展图标。
- 在搜索框中输入:openapi,Visual Studio Code 会自动进行查找。在结果列表中,点击
OpenAPI (Swagger) Editor
.
- 在扩展详情页面中,点击安装按钮,完成扩展插件的安装。安装完成后,按要求需要重新启动 Visual Studio Code.
开发环境介绍
- 重新打开 Visual Studio Code 后,左侧活动栏会出现一个新图标。
- 点击新的 Open API 图标,打开 OpenAPI 面板。
- 点击新建文档按钮,创建一个新的文档。
可以看到,新建的文档已经包含了一些必要的对象,我们已经在前面的文章里介绍过了。
在文档的左侧,是文档结构提纲,列出了 OpenAPI 根对象下的主要组成部分。
- 最后,保存新创建的文档,文件的扩展名可以是 .json or .yaml. 需要注意的是,文档保存成功后,智能感知功能,才会起作用。
其他编辑器
你还可以使用在线编辑器编写 OpenAPI 文档,如 Swagger Editor
,界面效果如下: