問題タブ [swagger-php]

CakePHP プロジェクトでSwagger-PHPを使用しようとしていますが、いくつかの問題があります。誰かがこれを設定しましたか？何かアドバイスはありますか？composer を使用して swagger-php を正常にインストールし、Controller 内にロードしました (以下を参照)。Web ビューを介して仕様をレンダリングしようとしていますが、レジストリが入力されていない理由、または入力する必要があるかどうかはよくわかりません。

以下はApiController.phpの内部です

結果

つまり、基本的に $swagResults は空であり、これは空であってはならないと思いますよね?

オブジェクトと文字列を関数に渡してレスラーでテストしようとしていますが、次の
エラーが発生します。

私が書いたドキュメントで：

これが関数です：

私はrestlerの直前のバージョンを使用しています。

PHPで作成されたjson-rpcサーバーにSwagger-uiを使用しようとしています。Swagger-PHPを使用して、Swagger-ui の json 苦情コンテナーを生成します。したがって、私は Swagger を初めて使用し、次のようなメソッドに注釈を使用します。

SWG\Operation では、json-rpc specに対応するもう 1 つの「メソッド」を追加する必要があります。その結果、すべてのリクエストは http の一部として POST メソッドを使用し、json コンテナはそれぞれに独自の「メソッド」を持ちます。

質問 - この問題を解決するには、どこから検索を開始すればよいですか?

私の英語でごめんなさい。ネイティブではありません。

私は Swagger-php と Swagger-UI を使用していますが、すべて問題なく動作しますが、1 つの問題があります。Swagger-UI が作成する UI には、API ルート用の予想されるクリックして展開するセクションがありますが、それぞれのタイトルは、生成された JSON ファイルであり、私が指定できる名前ではないようです。タイトルの後の説明は、私が注釈で付けたものですが、タイトルは私が制御できないようです。

したがって、/foo の resourcePath で始まるルートと、「Foo API 関数」という説明がある場合、UI は次のようになります。

foo.json : Foo API 関数

「foo.json」は必要ありません。むしろ、これが何を言っているのかを指定したいと思います。「Foo」または「Foo 関数」のように、説明をより意味のあるものに変更します。たとえば、「ここに foo 関数があります。」

これに使用する注釈がありませんか?

Slim を使用して小さな API を作成しようとしています。私はそれを非常によく文書化したいので、swagger-php と UI をインストールし、最後の数日間調査しました。何らかの理由で、ペットストアのデモに投稿の注釈がすべてありません。この例では、私の API は次のようになります。

http://coenraets.org/blog/2011/12/restful-services-with-jquery-php-and-the-slim-framework/

addWine() 関数のスワッガー アノテーションはどのようになりますか? モデルではないため、関数の結果 (最後の挿入 ID) に注釈を付けるにはどうすればよいですか?

例は本当に素晴らしいでしょう。ありがとうございました

調べてみると、一日中道に迷っていて、ぐるぐる回っているように感じます。

私は (いくつかのガイドの助けを借りて) Yii ベースのアプリケーション用の単純な API を作成しました。

他の人が使用できるように、この API を文書化するようになりました。私はどこでも、Swagger が API ドキュメントを実装する方法であると思われることを読みました。ただし、このアプリケーションの使用方法についてはどこでも取得できるようです

私はSwagger PHPの指示に従いました 。次に何をすべきかの例を誰かが持っているかどうか迷っています。

私は ApiController.php のいくつかの自己注釈を試みましたが、これはうまくいきません。swagger.phar コマンドラインを使用してみましたが、まだどこにも行きません。もっと多くの情報が必要になることは承知していますが、どのような情報が必要なのかわからないので、役に立たない情報をたくさん貼り付けるのではなく、質問してください。必要なものは何でもお送りします。

正直なところ、単純な API ドキュメントが欲しいだけですが、それは不可能に思えます。

乾杯

現在、プロジェクトのために、Swagger を使用してドキュメントを作成する必要があります。プロジェクトは php で行われるため、Swagger-Php を使用してコードに注釈を付け、ドキュメントを作成します。ここで、すべてのサンプル プロジェクトがオブジェクト指向であることに気付きました。つまり、リクエストが行われると、コントローラーが呼び出され、モデルなどが呼び出されます。私が参加しているプロジェクトでは、プロジェクトはこのように編成されていません。各ページには独自のファイルがあります。 、そのファイル内のすべての操作を処理します。このように Swagger を使用してコードを文書化するにはどうすればよいでしょうか?

たとえば、次の疑似コードは、基本的に各ファイルが行うことです。

私はこのようなことをしますか？

助けてくれてありがとう。