招摇PHP传递参数为json

时间:2018-07-04 13:48:43

标签: php swagger swagger-ui swagger-php

所以我在php代码中有如下注释,所以基本上我试图生成我的api接受的以下请求。

我有如下评论:

/**
* Login API
*
*

*@SWG\Definition(
*   definition="login",    
*   description="Enter your username",
*)

*@SWG\Definition(
*   definition="password",
*   type="string",
*   description="Enter your Password",
*)

* @SWG\Post(
* path="/user/login",
* description="Login API.",
* operationId="Login",
* produces={"application/json"},
* tags={"login"},
* consumes={"application/json"},

*@SWG\Parameter(
*          name="params",
*          in="body",
*          type="string",
*          default="params={""username"":""abc@abc.com"",""password"":""12345678""}",
*          description="Login Detail",
*          required=true,
*          @SWG\Schema(ref="#/definitions/login")
*),
*@SWG\Response(
*   response=200,
*   description="Token overview."
*),
*@SWG\Response(
*   response=401,
*   description="Unauthorized action.",
*),    
* )
*/

预期产量

curl -X POST \
  http://localhost/project/api/web/user/login \
  -H 'cache-control: no-cache' \
  -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  -H 'postman-token: 78219bf9-85a4-420f-7637-55e2f0e51b11' \
  -F 'params={"username":"abc@abc.com","password":"12345678"}'

实际输出

curl -X POST "http://localhost/project/api/web/user/login" -H "accept: application/json" -H "Content-Type: application/json" -d "params={\"username\":\"abc@abc.com\",\"password\":\"12345678\"}"

在Swagger-ui中,当我尝试执行它时,出现错误:

  

TypeError:无法获取

我尝试过的事情

  1. 更改消耗为“ multipart / form-data”(相同错误)
  2. 如果我将in =“ body”更改为in =“ query”,则它可以工作,但我不能使用它。按照在POST方法中传递参数的要求。
  3. 可能不相关,但是在控制台中我遇到以下错误:
  

root-injects.js:95 TypeError:e.get(...)。entrySeq不是一个函数       在t.default(curlify.js:23)       在t.value(curl.jsx:17)       在t.render(root-injects.js:93)       在u._renderValidatedComponentWithoutOwnerOrContext(ReactCompositeComponent.js:796)       在u._renderValidatedComponent(ReactCompositeComponent.js:819)       在u._updateRenderedComponent(ReactCompositeComponent.js:743)       在u._performComponentUpdate(ReactCompositeComponent.js:721)       在updateComponent(ReactCompositeComponent.js:642)       在u.receiveComponent(ReactCompositeComponent.js:544)       在Object.receiveComponent(ReactReconciler.js:122)

那我该怎么做才能解决此问题?

3 个答案:

答案 0 :(得分:1)

in="body",更改为in="formData",。瞧!

答案 1 :(得分:1)

从Swagger参数中删除默认属性,而是在swagger模式中进行设置。

@SWG\Schema(
    @SWG\Property(property="username", type="string", example="abc@abc.com"),
    @SWG\Property(property="password", type="string", example="12345678")
)

否则,如果要使用swagger定义,请在定义中如上所述设置swagger属性。

答案 2 :(得分:0)

通过结合@Pusparaj和@ delboy1978uk提供的答案来解决

基本上我必须将in="body"更改为in="formData"

之后,我必须像下面那样更改我的评论:

更早

*@SWG\Parameter(
*          name="params",
*          in="body",
*          type="string",
*          default="params={""username"":""abc@abc.com"",""password"":""12345678""}",
*          description="Login Detail",
*          required=true,
*          @SWG\Schema(ref="#/definitions/login")
*),

已更新

@SWG\Parameter(
    name="params",
    in="formData",
    type="string",
    default="params={""username"":""abc@abc.com"",""password"":""12345678""}",
    description="Login Detail",
    required=true,
    @SWG\Schema(
        @SWG\Property(property="username", type="string"),
        @SWG\Property(property="password", type="string")
    )
),