如何在Swagger PHP中指定默认JSON主体?
我想在Swagger PHP中为POST请求指定默认的JSON主体。我的注释如下所示:如何在Swagger PHP中指定默认JSON主体?,swagger,swagger-2.0,swagger-php,Swagger,Swagger 2.0,Swagger Php,我想在Swagger PHP中为POST请求指定默认的JSON主体。我的注释如下所示: /** * Setup order * * @SWG\Post( * path="/order/setup", * operationId="setupOrder", * tags={"Orders"}, * summary="Setup an order with status draft.", * description="Setup an
/**
* Setup order
*
* @SWG\Post(
* path="/order/setup",
* operationId="setupOrder",
* tags={"Orders"},
* summary="Setup an order with status draft.",
* description="Setup an order with status draft",
* consumes={"application/json"},
* @SWG\Parameter(
* name="body",
* in="body",
* default="{}",
* description="Json order info body (customer and products info)",
* required=true,
* @SWG\Schema(type="string")
* ),
* @SWG\Response(
* response=200,
* description="successful operation"
* ),
* @SWG\Response(response=400, description="Bad request"),
* security={
* {"api_key_security_example": {}}
* }
* )
*
*/
正如您所看到的,我正试图使用default=“{}”实现默认值,
但Swagger UI忽略此值,并将“string”作为默认值:
如何将“字符串”部分更改为默认JSON对象 您可以像下面这样使用
/**
* Setup order
* @SWG\Post(
* path="/order/setup",
* operationId="setupOrder",
* tags={"Orders"},
* summary="Setup an order with status draft.",
* description="Setup an order with status draft",
* consumes={"application/json"},
* @SWG\Parameter(
* name="body",
* in="body",
* default="{}",
* description="Json order info body (customer and products info)",
* required=true,
* @SWG\Schema(ref="#/definitions/testDefinitions")
* ),
* @SWG\Response(
* response=200,
* description="successful operation"
* ),
* @SWG\Response(response=400, description="Bad request"),
* security={
* {"api_key_security_example": {}}
* }
* )
* @SWG\Definition(
* definition="PlanResponse",
* example={
* "type":"string"
* }
* )
*/
谢谢,您可以像下面这样使用
/**
* Setup order
* @SWG\Post(
* path="/order/setup",
* operationId="setupOrder",
* tags={"Orders"},
* summary="Setup an order with status draft.",
* description="Setup an order with status draft",
* consumes={"application/json"},
* @SWG\Parameter(
* name="body",
* in="body",
* default="{}",
* description="Json order info body (customer and products info)",
* required=true,
* @SWG\Schema(ref="#/definitions/testDefinitions")
* ),
* @SWG\Response(
* response=200,
* description="successful operation"
* ),
* @SWG\Response(response=400, description="Bad request"),
* security={
* {"api_key_security_example": {}}
* }
* )
* @SWG\Definition(
* definition="PlanResponse",
* example={
* "type":"string"
* }
* )
*/
谢谢,您可以通过修改
@SWG\Parameter()
来实现预期目标
示例(查看属性的示例):
通过修改
@SWG\Parameter()
,您可以达到预期的效果
示例(查看属性的示例):