web-dev-qa-db-ja.com

springfoxとSwagger2を使用するときにv2 / api-docsがデフォルトのURLであるのはなぜですか?

私はこの guide の後にswaggerを使用し始めたところですが、私にとって意味のない非常に奇妙なものを見つけました。

覚えている限り、APIのバージョン番号2のドキュメントがある場合は、v2/api-docsを使用する必要があります。

したがって、デフォルトはapi-docsのみである必要がありますが、何らかの奇妙な理由で、デフォルトがv2/api-docsであることがわかりました。

私が見つけたライブラリドキュメントを確認する this

後でv2を使用できなくても、その値をオーバーライドするにはどうすればよいですか? (APIがv2に到達するが、レガシードキュメントも表示したい場合)。

あるいは、v2を使用するという私の概念が間違っているのでしょうか?誰かがこれで私を助けることができますか?

24
jpganz18

/v2/api-docs URLは、SpringFoxがドキュメントに使用するデフォルトです。 v2は、APIのドキュメントバージョン(Docket構成で変更可能)ではなく、使用されているSwagger仕様のバージョンを参照します。 SwaggerドキュメントURLをカスタマイズするための ドキュメントはこちら をご覧ください。つまり、ドキュメントが表示されるURLを変更するには、環境プロパティを変更する必要があります。

springfox.documentation.swagger.v2.path=/my/docs

これにより、SpringFox SwaggerドキュメントのデフォルトのURLが/v2/api-docs指定したものに。これを実装するには、上記のプロパティを新規または既存のプロパティファイルに追加し、Springfox構成クラスのプロパティソースとして追加します。

@PropertySource("classpath:swagger.properties")
@Configuration
public class SwaggerConfig {...}
40
woemler