设计移动提供商的服务,例如不同的SIM卡服务及其计划,即沃达丰及其每月不同的后付费计划(299,399,499 ...)
我正在swagger编辑器中创建1个端点,但是我必须添加的更多信息,然后swagger编辑器将在一段时间后变慢。
swagger:'2.0'#Swagger版本 info:#API的高级信息 描述:样本Swagger演示#给出API的描述 版本:1.0.0 #API版本 标题:移动服务#API标题 许可证:#Swagger许可证信息 名称:Apache 2.0 网址:“ http://www.apache.org/licenses/LICENSE-2.0.html” host:localhost:8080#主机名 basePath:/ v1#运行多个版本的API时的基本路径 标签:#每个API操作的标签信息。用于多个API操作的多个标签 -名称:Vodafone#标签名称 描述:有关您的Vodafone计划的所有信息#API操作的标签描述 方案: -http#安全方案 路径: / vodafone:#Request REST API的映射路径 获取:#Request方法类型,GET,POST等。 标签:#请参考上面创建的标签 -沃达丰 摘要:详细计划#摘要 描述:Vodafone Plan端点返回有关向客户提供的适合他们的计划的信息。响应包括显示计划的详细列表。 #API操作说明 operationId:getvodafoneDetails#方法名称 产生: -application / json#响应内容类型 参数: -名称:计划详细信息#输入参数 输入:path #path变量 描述:沃达丰计划#参数说明 必需:true#是强制性的 类型:整数#数据类型 格式:int64#数据类型格式,带符号的64位 响应:#API响应 '200':#成功的状态代码 描述:成功操作#成功状态描述 模式: $ ref:'#/ definitions / Vodafone'#响应对象详细信息 '400':#响应代码失败 描述:提供的VodafonePlan无效#响应描述失败 '404':#响应代码失败 描述:未找到计划#响应描述失败
定义:#对象定义 沃达丰:#Employee对象 类型:对象 属性:#Object属性 id:#Id属性 类型:整数 格式:int64 PlanDetail:#PlanDetail属性 类型:字符串 描述:沃达丰计划详细信息#数据类型描述 xml: 名称:员工#xml返回xml时的根元素
移动服务 1.vodafone:299次无限制通话,短信,4GB数据 399个无限通话,SMS,8GB数据 499个无限通话,SMS,8GB数据 2.想法:199个无限制电话,SMS,2GB数据 499个无限通话,短信,10GB数据
这将在招摇的编辑器中显示,用户将为其特定的提供者选择特定的计划。