关于Swagger规范

Swagger规范要点

定义
Swagger 是一套围绕OpeanAPI规范构建的开源工具，便于构建和使用REST API

主要Swagger工具有：
Swagger编辑器 - 基于浏览器的编辑器，可以在其中编写OpenAPI规范。
Swagger UI - 让OpenAPI规范以交互式API文档呈现。
Swagger Codegen - 让OpenAPI规范生成服务器静态文件(stubs)和客户端库

基本结构（使用的是Swagger 2.0）

swagger: "2.0" 
info:
  title: Sample API
  description: API description in Markdown.
version: 1.0.0

host: api.example.com
basePath: /v1
schemes:
  - https

paths:
  /users:
    get:
      summary: Returns a list of users.
      description: Optional extended description in Markdown.
      produces:
        - application/json
      responses:
        200:
          description: OK

主要分为元数据、基础路径、Consumes/Produces所支持的MIME类型、路径、参数、响应、输入/输出模型、认证等

结构详细说明转到 Swagger2.0 结构说明

OpenAPI规范要点

定义

OpenAPI Specification 是针对REST APIs的API描述格式。API规范格式：YAML和JSON

OpenAPI文件支持描述完整的API，包括：
1.可用的端点（/users）及在端点上的操作（GET /users,POST /users）
2.每种操作的输入输出参数
3.认证方式
4.联系信息，许可证，使用条款和其他信息。

持续更新。。

参考链接

Spring Boot 集成 Swagger
Swagger规范
OpenAPI规范
RestFul规范
RestFul资源详解及各种状态码