Swagger基本结构

Swagger是一种基于OpenAPI规范的开源工具,用于设计和描述后端服务的API。目前阿里云API网关支持导入Swagger2.0标准规范的文件以快速创建API。
 
 Swagger中所有参数与取值均区分大小写。
 
可同时支持.yaml和.json格式文件。
 
.yaml格式文件示例
 
swagger: '2.0'
 
info: {description: The description of group, title: groupName}
 
paths:
 
  '/path':
 
    method:
 
      ...
 
.json格式文件示例
 
{
 
    "swagger":"2.0",
 
    "info":{
 
        "description":"The description of group",
 
        "title":"groupName"
 
    },
 
    "paths":{
 
        "/path":{
 
            "method":{
 
                ...
 
            }
 
        }
 
    }
 
}