API 入门 (27) 使用 OpenAPI 描述 REST API——资源和操作

可以说,在前面的几篇文章中,我们已经对自行车在线商城的 REST API 进行了详细的设计(通过图和表格)。从今天开始,我们要使用 Open API 规范,对已有的 REST API 设计进行描述,朝着最终的开发实现,再迈进一步。

如果想了解和回顾 Open API 的基础知识,可以参考下面的文章:

如果想了解 Open API 环境的搭建,请参考下面的文章:

本文先对 REST API 的资源和操作进行描述。

创建文档

首先,我们创建一个空白的 Open API 文档,并修改自动产生的标题详细。

openapi: ‘3.0.2’
info:
  title: 自行车在线商城 REST API 文档。
  version: ‘1.0’
servers:
  - url: https://api.server.test/v1
paths:
  /test:
    get:
      responses:
        ‘200’:
          description: OK

接下来,我们以目录资源为例,对资源和操作进行描述。

把设计转成描述

描述资源

在 REST API 的设计中,我们已经识别出目录资源,并用 /bikes 表示资源的路径。现在通过文档进行描述。

openapi: ‘3.0.2’
info:
  title: 自行车在线商城 REST API 文档。
  version: ‘1.0’
servers:
  - url: https://api.server.test/v1
paths:  # 1
  /bikes: # 2
    description: 自行车目录 # 3

在 YAML 格式中,可以使用 # 添加注释,这也是 YAML 优于 JSON 的一个地方。

# 1,paths:表示资源的集合,所有资源都要放到这里。
# 2,/bikes:表示目录资源的路径。
# 3,description:对资源的额外描述。不强制,但推荐,很有用。

描述操作

在 Open API 文档中,资源必须包含相应的操作,否则文档是无效的。现在我们来添加查询操作。

openapi: ‘3.0.2’
info:
  title: 自行车在线商城 REST API 文档。
  version: ‘1.0’
servers:
  - url: https://api.server.test/v1
paths:
  /bikes:
    description: 自行车目录
    get: # 1 
      summary: 查询自行车目录 # 2
      description: |  # 3
        在自行车目录中,使用关键词,
        查询匹配条件的自行车。

# 1,get:get 属性对应的是 HTTP 的 GET 方法。
# 2,summary:表示操作的简短描述。
# 3,description:表示对操作的详细描述。

还记得 | 这个符号吗?在这里可以找到答案。

这时候,文档会提示一个警告:Missing property "responses".。我们必须需要为操作添加一个响应,满足文档的有效性。

openapi: ‘3.0.2’
info:
  title: 自行车在线商城 REST API 文档。
  version: ‘1.0’
servers:
  - url: https://api.server.test/v1
paths:
  /bikes:
    description: 自行车目录
    get: 
      summary: 查询自行车目录
      description: |
        在自行车目录中,使用关键词,
        查询匹配条件的自行车。
      responses:
        “200”:
          description: |
            满足查询条件的自行车

我们添加了一个 responses 属性,表示响应的集合,包含操作所有可能的响应。我们也添加了一个 "200" 响应,表示 HTTP 对状态码,意思是操作成功。最后,description 属性对响应对内容进行了说明。

响应具体包含了哪些数据,我们在后面对文章中进行详细说明。

小结

是不是把设计转换成语言描述很简单?这说明我们对设计工作发挥了作用,让接下来的工作水到渠成。等一等,还缺一个添加操作,请你动手写出来吧。

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

推荐阅读更多精彩内容