使用Swagger响应头405测试API时出错

时间:2018-01-23 11:30:14

标签: swagger api-design swaggerhub

所以我对创建API文档很新,我在通过swagger UI创建新条目时遇到了一些困难。我一直得到405回复。我不知道问题是什么,我变成了代码盲。 API的链接如下。任何指针都将非常感激。 https://swaggerhub.com/apis/Sharper-Web-Dev/test/1.0.0

1 个答案:

答案 0 :(得分:2)

您的定义指定SwaggerHub的模拟服务器(virtserver.swaggerhub.com)作为目标服务器。模拟服务器根据API定义中定义的responses生成响应。 POST /charity仅定义405响应,这就是模拟返回405的原因。

获得正常的"响应,您需要定义200 OK或201 Created响应,并添加描述所需JSON结构的响应schema(或响应examples

paths:
  /charity:
    post:
      ...
      produces:
        - application/json
      parameters:
        ...
      responses:
        200:
          description: OK
          schema:
            $ref: "#/definitions/MyResponseSchema"
        405:
          description: "Invalid input"  

有关详细信息,请参阅SwaggerHub文档中的How Response Mocking Works