OpenAPI中标签的确切用途以及它们为何唯一

时间:2018-11-28 10:25:06

标签: rest swagger openapi

按规范:

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md

规范与其他元数据一起使用的标签列表。标签的顺序可用于通过解析工具反映其顺序。并非必须声明操作对象使用的所有标签。未声明的标签可以随机组织,也可以根据工具的逻辑组织。列表中的每个标签名称必须唯一。

这些标记在解析器中如何使用,能否提供一些示例? 还有为什么需要唯一?

1 个答案:

答案 0 :(得分:3)

几个例子:


  

还有为什么需要唯一?

在不能使用相同名称的两个标签的意义上,标签名称必须唯一。

# Correct
openapi: 3.0.2
tags:
  - name: pet    # <--- unique tag name
    description: Operations to manage the pets

  - name: store  # <--- unique tag name
    descriptions: Access to Petstore orders


# Wrong
openapi: 3.0.2
tags:
  - name: pet
  - name: pet