問題タブ [nelmioapidocbundle]

Nelmio API Doc Bundle の Sandbox の Headers にパラメータを定義したい。

Nelmio ApiDoc の注釈でこれを定義するにはどうすればよいですか?

Nelmio API ドキュメントを使用して、FOSRestBundle と JMSSerializer を使用して REST API のドキュメントを生成しています。生成されたドキュメントによると、私の json オブジェクトは実際には配列です。オブジェクトがオブジェクトであるとドキュメントに記載するにはどうすればよいですか?

私はフードの下で知っています.phpではこれらのフィールドは実際にはキーと値の連想配列ですが、実際のjsonではそれらはオブジェクトであり、ドキュメントにそれを反映させたいと思います.

ここに私のコードエンティティがあります:

コントローラ：

私は Symfony 3 と NelmioApiDocbundle を使用しています (そして初めて使用します)。オプションのクエリ パラメータを持つ POST リクエストを処理したいと考えています。URL は次のようになります: http://example.com/api/updateusers?token=some_long_value

これは私が注釈のために試したことです:

要件、パラメーター、およびフィルターはすべて、API サンドボックスの POST 本文に表示されます。API サンドボックスでクエリ パラメータを表示するために使用できる別の定義タイプはありますか? サンドボックスをバイパスしてリクエストをサーバーに直接送信すると、トークンは GET 値として正しく表示されます。しかし、API サンドボックスをテストとドキュメンテーションに使用できるようにしたいと考えています。

デフォルトでは、ApiDoc は次のように、各 API エンドポイントのすべての操作を一覧表示します。

ただし、Swagger デモでは、ユーザーが操作を表示することを選択するまで、操作はデフォルトで非表示になっています。

デフォルトで操作を非表示にする ApiDoc の構成オプションはありますか? ドキュメントでこのようなものは見つかりませんでした。

私は Nelmio API Doc Bundle を使用して API ドキュメントを公開しています。ベース構成で使用しています。また、Symfony 3.1 を使用しています。しかし、コントローラーでは、ApiDoc アノテーション内で入力パラメーターを定義しても、ドキュメントには入力が表示されません。

不足している構成はありますか? または既知のバグ？

ありがとう

Nelmio Swagger UI ドキュメントをすべてオフにする方法はありますか? 本番環境では、次の URL で外部の世界に何も表示されないようにしたいのですが、開発環境では、便利なドキュメントとサンドボックスを通常どおり表示する必要があります。

• http://ourserver.com/api/doc
• http://ourserver.com/api-docs
• http://ourserver.com/api-docs/ *

Nelmio の設定で簡単に切り替えることができるはずですが、見つかりませんでした。私の会社は、Symfony の Nelmio API Doc バンドルを使用して、非公開 API の API を開発しています。API サーバーは公開されていますが、その使用法を世界に公開することには関心がありません。

私は FOSRestBundle を使用しており、Symfony ではかなり新しいものです。

私が見たいくつかの例に従ってきましたが、リクエストに複数のパラメーターを追加することはできません。

例えば

正常に動作しますが、次のようなバリエーションを実行したい場合:

うまくいきません。$id のみを識別します

私が気付いていない制限はありますか？または、私が行った単純な変更を超える追加の構成はありますか?