相关疑难解决方法(0)

定义全局参数

我正在准备我的API文档,而不是自动生成.我有标题应该发送到所有API,不知道是否可以为整个API全局定义参数?

其中一些标题是静态的,有些必须在调用API时设置,但它们在所有API中都是相同的,我不想复制和粘贴每个API和每个方法的参数,因为这不可维护未来.

我通过API定义看到了静态头文件,但是没有单个文档可以说明某人如何设置或使用它们.

这有可能吗?

swagger

22
推荐指数
1
解决办法
1万
查看次数

如何在Swagger 2.0中对多个参数进行分组?

是否可以将多个参数分组以在多个路径中引用它们?

例如,我在每条路线中都需要一组参数.它们被定义为全局参数.我怎么组他们?

我想到这样的定义:

parameters:
  MetaDataParameters:
    # Meta Data Properties
    - name: id
      in: query
      description: Entry identification number
      required: false
      type: integer

    - name: time_start
      in: query
      description: Start time of flare
      required: false
      type: string

    - name: nar
      in: query
      description: Active region number
      required: false
      type: string
Run Code Online (Sandbox Code Playgroud)

然后在我的路线中引用整个组:

/test/:
  get:
    tags:
      - TEST
    operationId: routes.test
    parameters:
      - $ref: "#/parameters/MetaDataParameters"
    responses:
        200:
          description: OK
Run Code Online (Sandbox Code Playgroud)

Swagger 2.0可以实现吗?

parameters definition swagger swagger-2.0

11
推荐指数
1
解决办法
5028
查看次数

标签 统计

swagger ×2

definition ×1

parameters ×1

swagger-2.0 ×1