六、注释:
一、SWG对象描述: @SWG\Swagger 声明一个SWG全局对象
固定字段
字段名称 |
类型 |
描述 |
|
需要。指定正在使用的Swagger规范版本。它可以被Swagger UI和其他客户端用来解释API列表。该值必须是 |
|
需要。提供关于API的元数据。元数据可以由客户端使用,如果需要的话。 |
||
|
提供API的主机(名称或IP)。这只能是主机,不包括方案和子路径。它可能包括一个端口。如果 |
|
|
API所服务的基本路径,相对于 |
|
|
API的传输协议。值必须是从列表: |
|
|
API可以使用的MIME类型列表。这对所有的API都是全局的,但是可以在特定的API调用上被覆盖。值必须如MIME类型下所述。 |
|
|
API可以生成的MIME类型列表。这对所有的API都是全局的,但是可以在特定的API调用上被覆盖。值必须如MIME类型下所述。 |
|
需要。API的可用路径和操作。 |
||
一个对象,用于保存操作生成和使用的数据类型。 |
||
保存可在各个操作中使用的参数的对象。该属性没有为所有操作定义全局参数。 |
||
保存可用于各个操作的响应的对象。这个属性没有定义全局响应的所有操作。 |
||