swagger $ref:
时间: 2023-09-15 21:20:10 浏览: 380
Swagger 使用
Swagger $ref 是 Swagger 规范中的一个关键字,用于在 API 文档中引用外部定义的 JSON 或 YAML 片段。通过使用 $ref,可以将重复的定义抽取出来并在其他地方进行引用,实现代码的重用和维护的方便性。
$ref 后面跟着一个字符串,该字符串指向要引用的定义的位置。这个位置可以是本地文件路径,也可以是网络 URL。Swagger 解析器会根据这个位置找到相应的定义,并将其合并到当前的上下文中。
例如,假设我们有一个定义如下的 swagger.yaml 文件:
```yaml
definitions:
Pet:
type: object
properties:
id:
type: integer
name:
type: string
```
如果我们在另一个地方想引用这个 Pet 定义,可以使用 $ref 来实现:
```yaml
paths:
/pets:
get:
responses:
200:
description: OK
schema:
$ref: '#/definitions/Pet'
```
在这个例子中,$ref 的值为 '#/definitions/Pet',它指向了 swagger.yaml 文件中的 Pet 定义。当解析器遇到这个 $ref 时,它会去找到 Pet 定义并将其合并到当前的上下文中。
这样,我们就可以在不同的地方引用相同的定义,避免了重复定义和维护上的困扰。
阅读全文