Sre*_*ree 8 rest swagger openapi
按规格:
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md
规范使用的带有附加元数据的标签列表。标签的顺序可以被解析工具用来反映它们的顺序。并非操作对象使用的所有标记都必须声明。未声明的标签可以随机组织或基于工具的逻辑。列表中的每个标签名称必须是唯一的。
这些标签在解析器中是如何使用的,你能提供一些例子吗?还有为什么需要是独一无二的?
几个例子:
Swagger UI 使用标签对 显示的操作进行分组。例如,Petstore 演示有三个标签 - pet
、store
和user
。
Swagger Codegen使用标签将端点分组到同一个 API 类文件中:
例如,
tags
将在StoreApi
类文件中生成带有“store”的端点。
还有为什么需要是独一无二的?
标签名称必须是唯一的,因为您不能有两个名称相同的标签。
# 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
Run Code Online (Sandbox Code Playgroud)
归档时间: |
|
查看次数: |
3279 次 |
最近记录: |