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

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 关于#wireshark#的问题:并且能够给数据做标注,如这个流量是在看视频或者是在转账
  • ¥90 请问,这个视频播放软件的名称,用过的朋友请给答案,上方..avi是啥意思?是看短剧还是播放本地视频?
  • ¥15 运筹优化,gurobi,python
  • ¥15 基于python的电影系统推荐
  • ¥20 springmvc重定向和返回json
  • ¥15 数学建模——参会安排怎么做
  • ¥15 电脑键盘实现触摸功能
  • ¥25 matlab无法将表达式转换为双数组怎么解决?
  • ¥15 单片机汇编语言相关程序
  • ¥20 家用射频美容仪技术规格