Javax上でSwaggerを使用してAPIドキュメントを生成します（JEEの下）？

Question

G'Evening、

SwaggerをJava EEでWildlfly上で実行されている既存のRESTプロジェクトに実装しようとしています。 目的は、実行時にREST-APIのドキュメントを生成することです。

しかし、必要な依存関係（io.swagger：威張っ-jaxrs）を追加した後、私たちのGradleのセットアップに、私たちはweb.xmlの

<servlet-mapping> 
<servlet-name>SwaggerConfig</servlet-name> 
<url-pattern>/api/documentation</url-pattern> 
</servlet-mapping> 

<servlet> 
<servlet-name>SwaggerConfig</servlet-name> 
<servlet-class>io.swagger.jaxrs.config.DefaultJaxrsConfig</servlet-class> 
<init-param> 
<param-name>api.version</param-name> 
<param-value>1.0.0</param-value> 
</init-param> 
<init-param> 
<param-name>swagger.api.basepath</param-name> 
<param-value>http://localhost:8080/api/documentation</param-value> 
</init-param> 
<load-on-startup>2</load-on-startup> 
</servlet> 

を経由して闊歩ジェネレータを設定しようとした私たちは、対処するために管理しますサーブレットは*/api/documentationの下にSOAPを介して置かれていますが、ドキュメンテーションやJSONファイルなどが生成されているようには見えないし、世代設定の場所や方法もわからないようです。

私たちが逃した可能性のあるガイドへの助け、助言、またはリンクは、高く評価されます。

Answer 1

Swaggerは、バックエンドサーバーの実行中にアクセス可能なHTMLページを生成します。

任意の有効なサイトへの/api/index.html