代码之家 › 专栏 › 技术社区 › Aris

无法获取数组密钥以使用Swagger

swagger-php swagger

Aris · 技术社区 · 8 年前

  /**
  * @SWG\POST(
  *   path="/visa-entry/calculate",
  *   operationId="visaEntryCalculate",
  *   tags={"Visa Entry"},
  *   summary="Calculate the price for an array of visa entries",
  *   description="Calculate the price for an array of visa entries",
  *
  *   @SWG\Parameter(
  *     name="entries",
  *     in="body",
  *     description="Visa Entry IDs to calculate to total price",
  *     required=true,
  *     @SWG\Schema(
  *       type="array",
  *       @SWG\Items(type="number")
  *     ),
  *     collectionFormat="multi"
  *   ),
  *
  *   @SWG\Response(
  *     response=200,
  *     description="OK"
  *   ),
  *
  *   @SWG\Response(
  *     response=400,
  *     description="Bad request"
  *   ),
  * )
  *
  * Calculates a visa entry
  */

我要做的是用键接收一个数字数组 entries 。

entries: [1, 2, 3]

此docblock渲染以下卷曲。

curl -X POST "app.test/visa-entry/calculate" -H "accept: application/json" -H "Content-Type: application/json" -H "X-CSRF-TOKEN: " -d "[0]"

如何让它发送带有密钥的数组 条目 ?

1 回复 | 直到 8 年前

Bob Fanger 8 年前

如果不希望客户端直接在请求正文中发布数组,但需要使用密钥,则需要指定 in=body 参数为 type="object" 并将数组定义为该架构的属性。

像这样:

/**
 * @SWG\POST(
 *   path="/visa-entry/calculate",
 *   operationId="visaEntryCalculate",
 *   tags={"Visa Entry"},
 *   summary="Calculate the price for an array of visa entries",
 *   description="Calculate the price for an array of visa entries",
 *
 *   @SWG\Parameter(
 *     in="body",
 *     name="json",
 *     description="Visa Entry IDs to calculate to total price",
 *     required=true,
 *     @SWG\Schema(
 *       type="object",
 *       @SWG\Property(
 *         property="entries",
 *         type="array",
 *         @SWG\Items(type="number")
 *       )
 *     ),
 *     collectionFormat="multi"
 *   ),
 *
 *   @SWG\Response(
 *     response=200,
 *     description="OK"
 *   ),
 *
 *   @SWG\Response(
 *     response=400,
 *     description="Bad request"
 *   ),
 * )
 *
 * Calculates a visa entry
 */

推荐文章

S.B Daniel Pryden · FastAPI中APIRouter的描述?

2 年前

Guilherme G · SWAGGER BUG:只允许一个参数(!已解决)

2 年前

Akari Oozora · Swagger/drf_yasg:Parameter对象需要模式或类型(而不是两者都需要)

2 年前

user3007447 · 仅当使用带日志级别警告的Serilog时,从DockerCompose启动Swagger需要5分钟以上

2 年前

defraggled · 使用openapi typescript codegen,为什么这个Swagger模式生成Record<string,any>的模型?

2 年前

noidea · 正在寻找在M1 Mac上通过docker运行swagger codegen cli的解决方法

2 年前

Raz Buchnik · Mono Swagger API规范与multi,针对微服务

2 年前

elham hassanzadeh · 我想在配置中添加两个版本。SwaggerDoc在服务中。AddSwaggerGen用于简化招摇

2 年前

Asit Sonawane · Nginx+Dotnet Docker-上游连接过早关闭

2 年前

Benjamin79 · 如何在swagger codegen中包含列表属性?

2 年前