私は Symfony 3 と NelmioApiDocbundle を使用しています (そして初めて使用します)。オプションのクエリ パラメータを持つ POST リクエストを処理したいと考えています。URL は次のようになります: http://example.com/api/updateusers?token=some_long_value
これは私が注釈のために試したことです:
/**
* Returns a JSON object.
*
* @ApiDoc(
* resource=true,
* description="Update a user's information.",
* requirements={
* {
* "name"="userid",
* "dataType"="string",
* "requirement"=".+",
* "description"="the user to update"
* }
* },
* parameters={
* {"name"="data", "dataType"="text area", "required"=true, "description"="Free form xml data."}
* },
* filters={
* {"name"="token", "dataType"="string", "required"=true, "description"="auth token for current user - user that you're making the request on behalf of."},
* },
* )
* @Route("api/updateusers")
* @Method("POST")
*/
要件、パラメーター、およびフィルターはすべて、API サンドボックスの POST 本文に表示されます。API サンドボックスでクエリ パラメータを表示するために使用できる別の定義タイプはありますか? サンドボックスをバイパスしてリクエストをサーバーに直接送信すると、トークンは GET 値として正しく表示されます。しかし、API サンドボックスをテストとドキュメンテーションに使用できるようにしたいと考えています。