By Specification:
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md
A list of tags used by the specification with additional metadat
A couple of examples:
Swagger UI uses tags to group the displayed operations. For example, the Petstore demo has three tags - pet
, store
and user
.
Swagger Codegen uses tags to groups endpoints into the same API class file:
For example, an endpoint with the "store"
tags
will be generated in theStoreApi
class file.
And also why need to be unique?
Tag names must be unique in the sense that you cannot have two tags with the same name.
# 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