doushi9856 2019-03-25 20:09
浏览 2634
已采纳

Swagger注释和OpenAPI v3.0中“Produces”的注释是什么?

On OpenAPI v2.0 and Swagger PHP the annotation for Produces was:

 /**
 * @SWG\Get(
 *      path="/posts",
 *      operationId="getPosts",
 *      tags={"Authentication"},
 *      produces="application/json"
 *      summary="Returns the posts",
 *      description="Returns the posts",
 *      @SWG\Response(
 *          response=200,
 *          description="Successful operation"
 *      ),
 * )
 */

But On OpenAPI v3.0 and Swagger PHP I cannot find on how to annotate the produces on the documentation it states the it is now an attribute of the response @OA\Response but I can not find an example I already try just putting "content" = "application/json" but it doesn't work.

  • 写回答

1条回答 默认 最新

  • dougang2749 2019-03-26 09:22
    关注

    You define all the possible response content types for each @OA\Response.

    E.g.:

         * @OA\Response(
         *         response=200,
         *         description="successful operation",
         *         @OA\JsonContent(
         *             type="array",
         *             @OA\Items(ref="#/components/schemas/Pet")
         *         ),
         *         @OA\XmlContent(
         *             type="array",
         *             @OA\Items(ref="#/components/schemas/Pet")
         *         )
         *     ),
    

    If your endpoint only generates JSON content, only define the entry for @OA\JsonContent.

    See the full example here.

    本回答被题主选为最佳回答 , 对您是否有帮助呢?
    评论

报告相同问题?

悬赏问题

  • ¥15 metadata提取的PDF元数据,如何转换为一个Excel
  • ¥15 关于arduino编程toCharArray()函数的使用
  • ¥100 vc++混合CEF采用CLR方式编译报错
  • ¥15 coze 的插件输入飞书多维表格 app_token 后一直显示错误,如何解决?
  • ¥15 vite+vue3+plyr播放本地public文件夹下视频无法加载
  • ¥15 c#逐行读取txt文本,但是每一行里面数据之间空格数量不同
  • ¥50 如何openEuler 22.03上安装配置drbd
  • ¥20 ING91680C BLE5.3 芯片怎么实现串口收发数据
  • ¥15 无线连接树莓派,无法执行update,如何解决?(相关搜索:软件下载)
  • ¥15 Windows11, backspace, enter, space键失灵