Swagger简介

// get(请求方式) /persons?pageSize=20&pageNumber=2
      parameters:
       - name: pageSize
         in: query      //就是这里,这里query表示参数请求
         description: Number of persons returned
         type: integer
       - name: pageNumber
         in: query
         description: Page number
         type: integer

// get(请求方式) /persons/{username}
      parameters:
        - name: username
          in: path          //这里path表示路径请求
          required: true    //这个表示路径参数必须填写,默认为false表示这个路径是可选填的
          description: The person's username
          type: string

      responses:
        '200':
          description: successful operation
          schema:
            type: array
            items:
              $ref: '#/definitions/Pet' //这个是连接底下的数据结构
              
              ....
              

//其实这就是数据库的结构              
 Pet:
    type: object
    required:
      - name
      - photoUrls
    properties:
      id:
        type: integer
        format: int64
      category:
        $ref: '#/definitions/Category'  //这个还可以关联另一个数据表内容 这样返回时很简单.
      name:
        type: string
        example: doggie                 //这是事例 在测试时就直接显示了
      photoUrls:
        type: array
        xml:                            // 这个xml可能是在选择返回为xml才有用 但一般是json格式 
          name: photoUrl
          wrapped: true
        items:                          //这个才是json正常显示的东西
          type: string
      tags:
        type: array
        xml:
          name: tag
          wrapped: true
        items:
          $ref: '#/definitions/Tag'
      status:
        type: string
        description: pet status in the store
        enum:
          - available
          - pending
          - sold
    xml:
      name: Pet              

parameters:
  - name: person
    in: body
    description: The person to create.
    schema:
      required:
        - username
      properties:
        firstName:
          type: string
        lastName:
          type: string
        username:
          type: string