PHP招摇过市查询参数
在我的Zend应用程序中,我正在为移动应用程序编写一个小API。 为了方便移动开发者,我使用了Swagger。 到目前为止,除了一个GET请求外,一切正常 当我在浏览器中调用/user/messages/{sessionToken}?numMessages={numMessages}&pageNr={pageNr}时,我得到了我想要的结果,但当我尝试让Swagger执行此请求时,只传输sessionToken。我试过这个注释来炫耀自己:PHP招摇过市查询参数,php,swagger,swagger-ui,swagger-php,Php,Swagger,Swagger Ui,Swagger Php,在我的Zend应用程序中,我正在为移动应用程序编写一个小API。 为了方便移动开发者,我使用了Swagger。 到目前为止,除了一个GET请求外,一切正常 当我在浏览器中调用/user/messages/{sessionToken}?numMessages={numMessages}&pageNr={pageNr}时,我得到了我想要的结果,但当我尝试让Swagger执行此请求时,只传输sessionToken。我试过这个注释来炫耀自己: /** * @SWG\Api(path="/user/m
/**
* @SWG\Api(path="/user/messages/{sessionToken}?numMessages={numMessages}&pageNr={pageNr}",
* @SWG\Operation(
* method="GET",
* summary="Gets messages paged",
* notes="",
* type="string",
* nickname="getUsermessagesPaged",
* authorizations={},
* @SWG\Parameter(
* name="sessionToken",
* description="The token from an active user session",
* required=true,
* type="string",
* paramType="path",
* allowMultiple=true
* ),
* @SWG\Parameter(
* name="numMessages",
* description="number of messages on page (numMessages & pageNr are ignored if not both are set)",
* required=true,
* type="string",
* paramType="query",
* allowMultiple=true
* ),
* @SWG\Parameter(
* name="pageNr",
* description="pagenumber (numMessages & pageNr are ignored if not both are set)",
* required=true,
* type="string",
* paramType="query",
* allowMultiple=true
* ),
* @SWG\ResponseMessage(code=200, message="json {messages => 'user_messages'}"),
* @SWG\ResponseMessage(code=400, message="json with error 'not logged in'")
* )
* )
*/
有人看到我的错误了吗
欢迎任何帮助
问候
罗特曼
更新:根据建议,我将两个参数类型都更改为“查询”,并更改了路径:
@SWG\Api(path="/user/messages/{sessionToken}",
但它不起作用
eclipse PDT中的xdebug显示:
requestURI => /ias/public/user/messages/{sessionToken}
及
以下是/user的输出:
{
"basePath": "http://localhost/ias/public",
"swaggerVersion": "1.2",
"apiVersion": "1.0.0",
"resourcePath": "/user",
"apis": [
{
"path": "/user/balance/{sessionToken}",
"operations": [
{
"method": "GET",
"summary": "Gets userbalance",
"nickname": "getUserdata",
"type": "string",
"parameters": [
{
"paramType": "path",
"name": "sessionToken",
"type": "string",
"required": true,
"allowMultiple": false,
"description": "The token from an active user session"
}
],
"responseMessages": [
{
"code": 200,
"message": "json {balance => 'user_balance'}"
},
{
"code": 400,
"message": "json with error 'not logged in'"
}
],
"notes": "",
"authorizations": {}
}
]
},
{
"path": "/user/login",
"operations": [
{
"method": "POST",
"summary": "Logs user into the system",
"nickname": "loginUser",
"type": "string",
"parameters": [
{
"paramType": "form",
"name": "email",
"type": "string",
"required": true,
"allowMultiple": false,
"description": "The user email for login"
},
{
"paramType": "form",
"name": "password",
"type": "string",
"required": true,
"allowMultiple": false,
"description": "The password for login in clear text"
}
],
"responseMessages": [
{
"code": 200,
"message": "json with session_id, user_id, user_balance"
},
{
"code": 400,
"message": "json with error 'no user with given email and password'"
},
{
"code": 400,
"message": "json with error 'invalid input'"
},
{
"code": 400,
"message": "json with error 'no post request'"
}
],
"notes": "",
"authorizations": {}
}
]
},
{
"path": "/user/logout",
"operations": [
{
"method": "POST",
"summary": "Logs user out",
"nickname": "logoutUser",
"type": "string",
"parameters": [
{
"paramType": "form",
"name": "sessionToken",
"type": "string",
"required": true,
"allowMultiple": false,
"description": "The token from an active user session"
}
],
"responseMessages": [
{
"code": 200,
"message": "json {result => 'deleted'}"
},
{
"code": 400,
"message": "json with error 'no user_session with given sid'"
},
{
"code": 400,
"message": "json with error 'invalid input'"
},
{
"code": 400,
"message": "json with error 'no post request'"
}
],
"notes": "",
"authorizations": {}
}
]
},
{
"path": "/user/messages/{sessionToken}",
"operations": [
{
"method": "GET",
"summary": "Gets new messages",
"nickname": "getUsermessages",
"type": "string",
"parameters": [
{
"paramType": "path",
"name": "sessionToken",
"type": "string",
"required": true,
"allowMultiple": false,
"description": "The token from an active user session"
}
],
"responseMessages": [
{
"code": 200,
"message": "json {messages => 'user_messages'}"
},
{
"code": 400,
"message": "json with error 'not logged in'"
}
],
"notes": "",
"authorizations": {}
},
{
"method": "GET",
"summary": "Gets messages paged",
"nickname": "getUsermessagesPaged",
"type": "string",
"parameters": [
{
"paramType": "path",
"name": "sessionToken",
"type": "string",
"required": true,
"description": "The token from an active user session"
},
{
"paramType": "query",
"name": "numMessages",
"type": "string",
"required": true,
"description": "number of messages on page (numMessages & pageNr are ignored if not both are set)"
},
{
"paramType": "query",
"name": "pageNr",
"type": "string",
"required": true,
"description": "pagenumber (numMessages & pageNr are ignored if not both are set)"
}
],
"responseMessages": [
{
"code": 200,
"message": "json {messages => 'user_messages'}"
},
{
"code": 400,
"message": "json with error 'not logged in'"
}
],
"notes": "",
"authorizations": {}
}
]
},
{
"path": "/user/userdata",
"operations": [
{
"method": "POST",
"summary": "Posts userdata",
"nickname": "postUserdata",
"type": "string",
"parameters": [
{
"paramType": "form",
"name": "sessionToken",
"type": "string",
"required": true,
"allowMultiple": false,
"description": "The token from an active user session"
},
{
"paramType": "form",
"name": "password",
"type": "string",
"required": false,
"allowMultiple": false,
"description": "new password"
},
{
"paramType": "form",
"name": "address",
"type": "string",
"required": false,
"allowMultiple": false,
"description": "new address"
},
{
"paramType": "form",
"name": "housenr",
"type": "string",
"required": false,
"allowMultiple": false,
"description": "new housenr"
},
{
"paramType": "form",
"name": "zip",
"type": "string",
"required": false,
"allowMultiple": false,
"description": "new zip"
},
{
"paramType": "form",
"name": "city",
"type": "string",
"required": false,
"allowMultiple": false,
"description": "new city"
},
{
"paramType": "form",
"name": "email",
"type": "string",
"required": false,
"allowMultiple": false,
"description": "new email"
}
],
"responseMessages": [
{
"code": 200,
"message": "json {user => 'userdata'}"
},
{
"code": 400,
"message": "json with error 'not logged in'"
}
],
"notes": "",
"authorizations": {}
}
]
},
{
"path": "/user/userdata/{sessionToken}",
"operations": [
{
"method": "GET",
"summary": "Gets userdata",
"nickname": "getUserdata",
"type": "string",
"parameters": [
{
"paramType": "path",
"name": "sessionToken",
"type": "string",
"required": true,
"allowMultiple": false,
"description": "The token from an active user session"
}
],
"responseMessages": [
{
"code": 200,
"message": "json {user => 'userdata', user_limit => 'userLimits'}"
},
{
"code": 400,
"message": "json with error 'not logged in'"
}
],
"notes": "",
"authorizations": {}
}
]
}
],
"produces": [
"application/json"
]
}
错误似乎是,我的招摇过市用户界面没有发送任何查询参数?
下面是一个只有一个查询参数的示例,即sessionToken:
(由FireBug 2.0.6监控)
答案是:
HTTP/1.1 400 Bad Request
Date: Tue, 25 Nov 2014 14:58:20 GMT
Server: Apache/2.4.9 (Win32) PHP/5.5.12
X-Powered-By: PHP/5.5.12
Content-Length: 25
Connection: close
Content-Type: application/json; charset=utf-8
答案是正确的,因为没有传输sessionToken
这个请求是有效的,但它不是来自招摇过市的用户界面:
GET /ias/public/user/balance?sessionToken=54275cc6358e42c4b1fb1d8daf850b52 HTTP/1.1
Host: localhost
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:33.0) Gecko/20100101 Firefox/33.0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: de,en-US;q=0.7,en;q=0.3
Accept-Encoding: gzip, deflate
Cookie: __utma=111872281.581414660.1366700677.1394721873.1394723866.255; uvts=sB5Dda3cZBNdaTk; searchpanel-close=set
Connection: keep-alive
我想你失踪了
paramType="query",
到
我认为这将解决您的问题将第一行更改为:
* @SWG\Api(path="/user/messages/{sessionToken}",
Swagger不支持将查询参数作为路径本身的一部分。它们将自动添加到请求中(从UI),因为它们被描述为
query
类型。问题已经解决,解决方案是更新swagger UI
更新后,查询参数已发送到应用程序,一切正常
感谢所有试图解决我问题的人
问候
罗特曼谢谢你的回答,但那不管用,我以前试过。我将所有三个paramTypes都设置为Path,但在这两种情况下都没有传输params“numMessages”和“pageNr”。您是否在控制台中检查了这一点?allowMultiple=true删除此选项,然后尝试在eclipse PDT的xdebug会话中查看请求。我还删除了“allowMultiple=true”->在第十八次测试中无效。谢谢你的回答,但它在第十八次测试中无效。我在xdebug中检查了请求参数,没有收到任何提交的参数。你还有别的想法吗?是的。您能否修改您的问题并添加从应用程序中获得的招摇过市的JSON?已更改。但是我有点困惑api调用没有显示?我假设您是从/api文档中获得的。您能看到/api docs/user(或/api docs/\user)的输出吗?我添加了“/user”的输出。我真的很感激!有一件事还不清楚,那就是你在观察问题的时候。是在应用程序启动时吗?是在运行Swigger UI操作时吗?当我运行Swigger UI操作时,它不起作用,当我使用Chrome Postman执行请求时,一切正常。好的。主要问题是在/user/messages/{sessionToken}上有两个GET操作。我假设您使用的是我不熟悉的swagger php,所以很遗憾,我无法告诉您为什么它会这样做。非常感谢。是的,我用的是招摇过市的php。为了进行测试,我删除了一个get操作,但错误仍然存在。我不知道出了什么问题。你在UI中看到了什么错误?如果看不到任何特定内容,请尝试检查浏览器的web控制台并查看网络。检查请求和响应,您甚至可以将它们粘贴到此处。
GET /ias/public/user/balance?sessionToken=54275cc6358e42c4b1fb1d8daf850b52 HTTP/1.1
Host: localhost
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:33.0) Gecko/20100101 Firefox/33.0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: de,en-US;q=0.7,en;q=0.3
Accept-Encoding: gzip, deflate
Cookie: __utma=111872281.581414660.1366700677.1394721873.1394723866.255; uvts=sB5Dda3cZBNdaTk; searchpanel-close=set
Connection: keep-alive
paramType="query",
paramType="path",
* @SWG\Api(path="/user/messages/{sessionToken}",