API 入门(11)OpenAPI 实战——开发环境

在往期的文章中,我们对 OpenAPI 规范有了一个基本的了解,接下来的几篇文章,我们会通过一个实际应用场景,编写一个完整的 OpenAPI 文档。

工欲善其事,必先利其器。今天我们先来搭建文档编写的环境。

OpenAPI 文档是一个纯文本文档,不管是 JSON 格式,还是 YAML 格式。同时,纯文本文件也有利于存储和版本化管理。你可以使用自己喜欢的文本编辑器,但是,为了提高效率,避免不必要的语法错误,我们还是建议使用较为专业的文本编辑器。

下面,我们就介绍如何使用 Visual Studio Code 建立 OpenAPI 文档开发环境。

安装 Visual Studio Code

如果你已经安装过 Visual Studio Code 了,可以忽略本节。

Visual Studio Code 是一款免费、开源、跨平台的轻量级开发工具。通过安装和配置不同的插件,可以支持不同语言的开发。

访问官方网站,根据所使用的操作系统,下载对应版本的软件。

Visual Studio Code 官网

运行软件安装包,按默认提示安装即可。

安装 OpenAPI 插件

新安装的 Visual Studio Code 只具备基本、通用的开发能力,如果要针对特定语言或平台开发,需要安装相应的插件。下面我们就安装支持 OpenAPI 文档编写的插件:OpenAPI (Swagger) Editor.

  1. 打开 Visual Studio Code,点击左侧活动栏的扩展图标。
左侧活动栏
  1. 在搜索框中输入:openapi,Visual Studio Code 会自动进行查找。在结果列表中,点击 OpenAPI (Swagger) Editor.
搜索扩展
  1. 在扩展详情页面中,点击安装按钮,完成扩展插件的安装。安装完成后,按要求需要重新启动 Visual Studio Code.
安装扩展

开发环境介绍

  1. 重新打开 Visual Studio Code 后,左侧活动栏会出现一个新图标。
OpenAPI 图标
  1. 点击新的 Open API 图标,打开 OpenAPI 面板。
OpenAPI 面板
  1. 点击新建文档按钮,创建一个新的文档。
空白文档

可以看到,新建的文档已经包含了一些必要的对象,我们已经在前面的文章里介绍过了。

在文档的左侧,是文档结构提纲,列出了 OpenAPI 根对象下的主要组成部分。

  1. 最后,保存新创建的文档,文件的扩展名可以是 .json or .yaml. 需要注意的是,文档保存成功后,智能感知功能,才会起作用。

其他编辑器

你还可以使用在线编辑器编写 OpenAPI 文档,如 Swagger Editor,界面效果如下:

swagger_editor.png

往期文章

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,100评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,308评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,718评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,275评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,376评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,454评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,464评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,248评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,686评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,974评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,150评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,817评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,484评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,140评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,374评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,012评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,041评论 2 351

推荐阅读更多精彩内容