swagger_php注释详解

本文详细解析了如何使用Swagger的PHP注释来描述Swagger全局对象、信息对象、请求操作、参数、响应及模式对象,包括相关字段和示例代码,帮助理解如何构建API接口文档。
摘要由CSDN通过智能技术生成

六、注释:

一、SWG对象描述: @SWG\Swagger  声明一个SWG全局对象

固定字段

字段名称

类型

描述

swagger

string

需要。指定正在使用的Swagger规范版本。它可以被Swagger UI和其他客户端用来解释API列表。该值必须是"2.0"

Info

信息对象

需要。提供关于API的元数据。元数据可以由客户端使用,如果需要的话。

host

string

提供API的主机(名称或IP)。这只能是主机,不包括方案和子路径。它可能包括一个端口。如果host不包括,将使用提供文档的主机(包括端口)。在host不支持路径模板

bashpath

string

API所服务的基本路径,相对于host。如果没有包含,则直接在API下提供API host。该值必须以一个前导斜杠(/)开始。在basePath不支持路径模板

schemes

string

API的传输协议。值必须是从列表:"http""https""ws""wss"。如果schemes不包含,则使用的默认方案是用于访问规范的方案。

consumes

string

API可以使用的MIME类型列表。这对所有的API都是全局的,但是可以在特定的API调用上被覆盖。值必须如MIME类型下所述。

produces

string

API可以生成的MIME类型列表。这对所有的API都是全局的,但是可以在特定的API调用上被覆盖。值必须如MIME类型下所述。

paths

操作对象

需要。API的可用路径和操作。

definitions

定义对象

一个对象,用于保存操作生成和使用的数据类型。

parameters

参数定义对象

保存可在各个操作中使用的参数的对象。该属性没有为所有操作定义全局参数。

responses

响应定义对象

保存可用于各个操作的响应的对象。这个属性没有定义全局响应的所有操作。

  • 0
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 5
    评论
评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值