Question

我是一个狡猾的人，我正试图开始记录API。我想在我的文档中包含请求/响应的示例，而不仅仅是模式定义本身。

有一个＆＃34;例子＆＃34;但是，当我填写此对象时，它不会显示在生成的文档中的任何位置。这只是暂时没有招摇的缺失功能，还是我错误地使用了这个功能？

这是我的规范（我知道我还没有正确实施安全性）：

swagger: '2.0'
schemes: ['https']
info:
  version: 1.0.0.0
  title: 'Test API'
  contact:
    name: Support
    url: 'www.nowhere.com'
    email: 'test@example.com'
consumes: ['application/json']
produces: ['application/json']
paths:
  /Variables:
    get:
      summary: 
        Returns the list of all variables in the system.
      description:
        Returns the list of all variables in the system.
      tags: ['Variables']
      consumes: ['application/json']
      produces: ['application/json']
      parameters:
        - name: "Authorization"
          in: header
          description: "Provide the OAuth access token in the format of: Bearer token_value"
          type: string
      responses:
        '200':
          description: Successful response
          schema:
            $ref: '#/definitions/Variables'
          examples:
            application/json:
              VariableToken: Name
              VariableGroupName: Main
              DataType: text
              VariableDisplayName: Name
definitions:
  Variables:
    type: array
    items:
      title: Variable
      type: object
      properties:
        VariableToken:
          type: string
          format: string
        VariableGroupName:
          type: string
          format: string
        DataType:
          type: string
          format: string
        VariableDisplayName:
          type: string
          format: string

Answer 1

我想出来了。我将我的示例放在正确的位置，但是，Swagger Editor不会在预览窗口中显示它。但是，Swagger UI将使用此信息生成UI。

Swagger：在哪里为呼叫提供样本json？

1 个答案: