如何使用Google JSON样式对API进行建模

时间:2019-03-18 03:26:56

标签: swagger openapi

如问题所述。我想在openapi yaml中为谷歌风格的json格式建模

https://google.github.io/styleguide/jsoncstyleguide.xml

Google json样式将dataerrors指定为动态字段

如何将数据/错误模型放入定义中,该模型将另一个定义作为动态数据或错误的值?

例如,以下是典型成功响应的定义。如何建模可重用的响应定义,以便它可以将数据作为动态字段并接受$ ref作为动态参数?

200:
      description: Successful operation
      content:
        application/json:
          schema:
            type: object
            apiVersion: string
            context: string
            properties:
              data:
                $ref: "./external.yaml#/Dog"

0 个答案:

没有答案