3

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

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

foo.json : Foo API 関数

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

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

4

3 に答える 3

0

swagger-php私もこの問題に遭遇しましたが、これについて言及しているページまたはswagger-uigithub ページのいずれにも何も見つかりませんでした。そこで、回避策として短いビルド スクリプト (Unix ライクな OS を想定) を作成しました。これは、最初に を使用してすべてのドキュメントをビルドしswagger.phar、次に実行sedして、問題のある文字列のインライン文字列置換を行います。これが私が以下にしたことです：

#!/bin/bash

# write API documentation from "src" directory to the "docs" directory
/usr/bin/php swagger.phar src -o docs

# replace instances of "json" with "{format}" to fix swagger-php formatting issue
sed -i -e 's/json/{format}/g' docs/api-docs.json
于 2014-03-13T18:32:59.693 に答える
0

swagger-php 0.9.1 で修正済み

なぜswagger-uiが削除されるのかわかりませんが、そうではありませ".{format}"ん".json"

.{format}混乱を招く可能性があるため、デフォルトでは挿入されませんでした。さまざまな形式が存在することを示唆しており、swagger-php は json 形式のみをサポートしています。

于 2014-03-21T15:04:36.913 に答える
0

api-docs.json ファイルを手動で編集する場合。.json を .{format} に置き換えると、すべてが正しく表示され、正しく機能します。デフォルトで .{format} が挿入されない理由がわかりません。少し面倒です。

于 2014-03-09T22:57:34.147 に答える