swagger规范

这是一篇关于swagger规范的思维导图，parameters(参数)、responses（返回体）、requestBody。

swagger规范

• openapi
• Info
  • title
  • description
  • version
• Servers
  • -url:
  • description
• Paths
  • /actions
    • get/post
      • tags（分类）
        • 分类url
      • summary(描述)
      • security(是否有token)
      • parameters(参数)
        • _$ref:#/components/parameters/table'
        • 查询路径中的字符串格式
          • ！！！看不懂
          • 查询字符串参数不得包含在路径中。它们应该被定义为查询参数
      • responses（返回体）
        • 200
          • description
          • content
            • application/json
              • media type
              • schema
                • type
                • properties
                • $ref: '#/components/schemas/basic_error'
                  • 可以理解为一个表，type表示是表，properties可以理解为列值 
                • example:
                • items
                  • type
            • images
        • 401
        • 404
        • 500
      • requestBody
        • post，put,patch请求
        • description
          • description: Optional description in *Markdown*
          • 支持Markdown
        • required
          • 可选
        • content
          • application/json
            • schema
              • type
              • propertines
            • encoding
              • color
              • bar
              • baz
      • description
      • externalDocs
        • 用于引用包含附加文档的外部资源
        • description
        • url
      • deprecated:true
        • 弃用的操作
  • /users/{id}
    • get
      • operationId:getUserById
      • parameters
        • -name:id
        • in:path
        • discription
        • required:true
        • schema:
          • type
          • format
      • responses
        • 200
          • ----
• components
  • Compnents
    • Schemas
      • Employee
        • type
        • properties
    • Parameters
    • ScuritySchems
      • apikeyAuth
        • type
        • in
        • name
    • requestbodies