在OpenAPI规范中,可以使用tags字段来给API分组。这些tags可以包含任意的标识符,方便我们按照自己的需求来分组。
例如,我们可以为请求参数中包含的不同的城市名来分组API。示例代码如下:
openapi: "3.0.0"
info:
title: My API
version: 1.0.0
paths:
/cities/{city}/restaurants:
get:
tags:
- New York City
parameters:
- name: city
in: path
required: true
schema:
type: string
responses:
'200':
description: A list of restaurants in the specified city.
在以上示例中,我们使用了'New York City”作为标签,来将API按照城市名来分组。其他API可以使用不同的标签,根据自己的需求来创建不同的分类。
这种方法可以更好地组织大型API,让用户更容易找到和使用。
上一篇:按参数过滤数组
下一篇:按参数名称解析扩展方法