問題タブ [nelmioapidocbundle]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
php - composer を更新した後、Nelmio Api Doc のグループ除外が機能しない
http://jmsyst.com/libs/serializer/master/reference/annotationsで説明されているように、パラメーターを配列として設定しました
別のクラスでいくつかのオプションを定義します
@ApiDoc で定義します
更新前は問題なく動作しています。ただしcomposer update
、「QuestionAnswer」グループ名のみが機能し、QuestionOptions クラスのすべてのプロパティが表示されます。更新前と同じように、配列内のプロパティを送信するにはどうすればよいですか?
symfony - nelmio サンドボックスに oauth2 サポートを追加
私は Symfony2 (FosRestBundle で作成) で REST API に取り組んでいます。
oauth が有効になる前に、nelmioが提供するサンドボックスで API メソッドを試すことができました。
例:
ただし、API メソッドを呼び出すために oauth が有効になっているため、oauth トークンをクエリ文字列として追加する必要があります。
例:
これらの API 呼び出しは、問題なく nelmio の外部で機能します。
nelmio で oauth のサポートを有効にするために、次の構成を に追加しました/app/config.yml
。
その後api key
、画面の上部で を要求しますが、そこに oauth トークンを設定すると、サンドボックスを使用しようとすると、まだ承認されていない応答が返されます。
これを修正する方法はありますか?
mongodb - NelmioApiDocBundle は mongoDB ドキュメントを解析できません
API-Rest のドキュメントには NelmioApiDocBundle を使用しています。エンティティ クラスを使用すると、ドキュメント (入力と出力) が正しく作成されます。それにもかかわらず、Nelmio は MongoDB の Document クラスのドキュメントを作成していません :(
何か案は?
php - FOSRestBundle "いくつかの必須パラメーターがありません (id)" とルート パラメーター
Symfony 2.7.3 と FOSRestBundle を使用して 1 つの REST API を構築しています。私のモデルにはuser
と がありますtickets
。ユーザーはチケットを持つことができ、/user/{id}/tickets エンドポイントを呼び出してユーザー チケットを取得したいと考えています。私の API には、page と limit のクエリ パラメータがあります。param_fetch_listener: force
メソッドパラメーターを注入するために使用しています。ルート パラメーターとクエリ パラメーターを混在させようとすると、エラーが発生します"Some mandatory parameters are missing (id)"
。私のメソッド注釈は次のとおりです。
エンドポイントに到達すると、エラーが発生します: "Some mandatory parameters are missing (\"id\") to generate a URL for route \"api_1_get_users_tickets\"."
. それを解決する方法についてのアイデアはありますか?ありがとう!
編集: 上記のコードは正常に動作しています。エラー メッセージは、私が内部に持っていたコードに関連しています// my code
。空の戻り値でメソッドを試したところ、うまくいきました。いくつかの内部ロジック内で自分の ID がありませんでした。混乱させて申し訳ありません。この問題をクローズするか、今後の参考のためにここに残しておくかを考えます。ありがとう!
php - Nelmio Api Doc Bundle: 必要なパラメーターのドキュメント化
私は現在、まだよく知らない NelmioApiDocBundle を使用しています。私が書いている API は、特定のユーザーのパスワードを変更するためのルートを提供する必要があります。ドキュメントには、パスワードを変更するには古いパスワードと新しいパスワードの両方が必要であると記載されている必要があります。と の違いの説明が見つからなかったので、前者はルートからのデータに使用され、後者は API 呼び出し自体に使用されているRequirements
とParameters
思います。
このようなドキュメントをアーカイブする最初の試みは、JMSSerializerBundle が自動的に変換する単純なモデルを実装することでした。
コントローラは、次のアクション メソッドを介して API 呼び出しを受け入れます。
これにより、ドキュメントusername
が要件として、old_password
およびnew_password
パラメーターとして表示されるようになりました。これらのパラメーターを必須としてマークするために、アノテーションを介して Symfony Constraint をプロパティに追加しました。
ただし、これらの注釈を使用するとプロパティが必須としてマークされますが、奇妙な出力が生成されます。
パラメータが 2 回、異なる形式で追加されていることに注意してください。を追加し@SerializedName("old_password")
ても効果はありません。このチケットに関しては、まだ問題は解決していません。
アクションのデータを受け入れる別の方法は、カスタム フォームを使用することです。これは、実際にはプロパティを必須としてマークしますが、適切な出力も生成しません。ChangePasswordParam
カスタム フォームとしての変更:
これらのパラメーターには「old_password」と「new_password」という名前を付ける必要がありますが、これをアーカイブする方法がわかりません。
前もって感謝します
symfony - NelmioApiDocBundle によって生成されたドキュメントから _format URL サフィックスを削除するには?
Symfony に新しい API 指向のプロジェクト用に をインストールしましたが、このバンドルがすべてのエンドポイント URL に追加するサフィックスをNelmioApiDocBundle
取り除くことができません。.{_format}
これはどのように見えるかです:
_format
私の API はas サフィックスをサポートしていません。クエリ パラメータとして、またはリクエスト ヘッダーによってサポートされます。そのため、NelmioApiDocBundle サンドボックスからこのエンドポイントにリクエストを送信しようとすると、404 エラー レスポンスが返されます。
これは、nelmio に関する現在の config.yml セクションです。
yml
nelmio_api_doc:
name: My API doc
sandbox:
enabled: true
endpoint: null
accept_type: application/json
body_format:
formats: null
default_format: json
request_format:
formats:
json: application/json
xml: null
method: accept_header
default_format: json
authentication:
name: bearer
delivery: query
cache:
enabled: false
file: '%kernel.cache_dir%/api-doc.cache'
forms - NelmioApiDocBundle は、ネストされたフォームで FormType を使用するときに追加の入力を生成します
私は NelmioApiDocBundle を使用して API ドキュメントを生成しています。問題は、ネストされたフォームまたはボタン (送信/キャンセル) で FormType を使用すると、余分なパラメーターが取得されることです。これは私の FormType です:
そして私のコントローラーで:
これらの余分なパラメーター (ユーザー、連絡先、バリダー) を削除するにはどうすればよいですか?