#第一部分基本配置信息
#采用 swagger版本
swagger: ‘2.0’
#项目信息
info:
version: “1.0.0”
title: 社交项目-基础-城市API
#主机地址
host: localhost:9001
#基础路径
basePath: /base
#API的传输协议
schemes:
- #减号代表多个值
http - https
#提交参数格式
consumes:
application/json
#响应结果格式
produces:
application/json
#第二部分定义 url配置 什么请求 提交方式 什么参数都在这儿
paths:
#新增城市数据
/city:
post: #提交方式
description: 新增城市数据
parameters: #指定提交参数(名称-参数类型-是否必填)
-
name: body #参数通过请求体提交 -json数据
in: body #提交参数格式 body:json数据 path:url地址提交参数 /{cityId}
#query:url地址提交参数 ?cityId=123
required: true
description: 城市实体信息
#引用定义实体
schema:
$ref: ‘#/definitions/City’
responses: #响应结果
200:
description: 请求成功
schema:
$r