問題タブ [swagger-php]
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.
swagger - 同じメソッドの 2 つのパス
Swagger-php を使用して、Swagger を使用して PHP Rest API のドキュメントを生成しようとしています。
ドキュメンテーションのために巨大なコメントブロックを持つのが好きかどうかはよくわかりませんが、それは問題ではありません。
私には2つの道があります:
両方とも、私の PHP コードで同じメソッド login() を呼び出します。
/user/ [POST] は単なる /user/login [POST] のエイリアスだと言う方法はありますか?
両方とも操作のリストに表示され、ドキュメントが完成し、ユーザーにオプションを提供するためのパスが異なるだけで、同じことを行うと述べてください。
もちろん、コメント ブロックをコピーして貼り付けることもできますが、別のメソッドを呼び出すだけの 1 行のメソッドに 50 行のコメント ブロックは必要ありません。
何か案は ?
php - swagger-php having different documentations from the same code
We are using slim framework and swagger-php to dynamically generate the swagger documentation. We now have some special methods in the API that should not be publicly documentated. (/doc now) Is there any way I can have a second documentation url (/doc2) where I can get the secret methods and params documentated? (without having to make the documentation by hand, just using the annotations in the php code). Thanks.
swagger - Swagger で GET リクエストのモデル/サンプル値セクションを生成する方法
Swagger を使用した GET リクエストの Model/Example 値セクションの生成に関心があります。 公式の例へのリンクは、そのセクションを完全に示しています。
公式ドキュメントでは、既存のモデルを使用して生成されます。
プロパティは REST によって生成されるため、そのようなオプションはありません。
私は次の方法を試しました:
機能しておらず、次のように答えています。
fetching resource list: http://localhost/dist/swagger.json; Please wait.
どんな助けでも大歓迎です。前もって感謝します。
php - swagger アノテーションで定数を使用する
私は次のコードを持っています:/lib/App/Vendor/bin
私はファイルを作成しました:今実行しようとしたときにconstants.php
定義し
ますdefine('AUTH', 'test');
php swagger --boostrap constants.php
エラーが発生します:
Scanning files in '/lib/App/Vendor/bin' ...[INFO] Required @SWG\Info() not found
どこに問題があるのか わかりません。私を助けてください !事前にthx!助けてください...誰かが問題になりましたか??
php - Swagger PHP - ネストされたプロパティを定義する方法は?
私は Swagger PHP を使用しており、ほとんどの定義は簡単に定義できますが、別のクラスの一部ではなく、連想配列である特定のデータに問題があります。
表示したいjson応答(この質問のために簡略化):
id
とstatus
は簡単に定義できますが、を定義する別のgps
クラスがなく、モデル内の配列であるため問題です。ダミー クラスを作成せずにこの配列を定義することは可能ですか?
現在のモデル ファイルのコメント:
php - クエリ文字列で swagger-php に配列を使用させることはできますか?
私はSwagger-phpを使用しています。クエリ文字列にあるパラメーターを定義すると、配列にすることができます。しかし、私が見る限り、この種のクエリ文字列はサポートされていません:
可能であれば、これはcollectionFormat
フィールドに設定されると思います。現在は を使っているだけpipes
ですが、上記のフォーマットを使いたいし、Swagger-UI にも反映させたいです。しかし、これが実際に可能かどうか疑問に思っていたこのgithubの問題を読んだのですが、見逃してしまいましたか?
私の Swagger-PHP 定義の例:
これにより、次の JSON が生成されます。
php - swagger php apiアノテーションでオプションのパラメータを渡す方法は?
私はswagger uiを使用しており、オプションのパラメーターを取るGet APIを持っていますが、以下のAPIに注釈を付けることができません。私が試したmakeコードです:
私のGet API構造は次のようなものです:
しかし、私がこれを試しているとき、swagger ui はidオプションのパラメーターを取りません。必要なパラメーターを取ります。助けてください..