1

Wildfly Swarm (現在は Thorntail) で構築されたアプリケーションがあり、ドキュメント用に Swagger を REST API と統合し、それを使用して Swagger-UI でテストしています。

アプリケーションを本番環境にデプロイするときに、Swagger-UI 部分を無効にできるかどうかを知りたいです。swagger のドキュメントを調べて、これに関するプロパティがあるかどうかを確認しようとしましたが、何も見つかりませんでした。Thorntail のドキュメントでも同じです。

考えられる解決策の 1 つは、jar をビルドするときに maven プロファイルを介して swagger-ui maven 依存関係を無効にすることです。これを避けたいのは、本番用と開発用に 1 つの jar が必要になるからです。

多くの提案を見ましたが、Spring Boot に固有のようです。

4

1 に答える 1

0

独自の swagger-ui インスタンスをホストし、thorntail のインスタンスを使用しないことをお勧めします。swagger-ui は開発ツールであり、thorntail サービスでは直接使用しないと考えているためです。

swagger-ui が外部のスタンドアロン サービスとしてホストされていて、html と javascript だけであるため、すべての開発者に対して 1 つのインストールのみが必要な場合は、*/swagger.json を提供するエンドポイントのサービスで CORS に注意するだけで済みます。 . 実稼働環境で swagger.json を提供しても問題はありません。これは、残りの API の単なるドキュメントであるためです。

Java Web アプリケーションで CORS の問題からコピーされた CORS フィルターを実装するには、次の例を参照してください。

public class CorsFilter implements Filter {


    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        response.setHeader("Access-Control-Allow-Origin", "*");
        response.setHeader("Access-Control-Allow-Credentials", "true");
        response.setHeader("Access-Control-Allow-Methods", "POST, GET, HEAD, OPTIONS");
        response.setHeader("Access-Control-Allow-Headers", "Origin, Accept, X-Requested-With, Content-Type, Access-Control-Request-Method, Access-Control-Request-Headers");
      if ("OPTIONS".equalsIgnoreCase((HttpServletRequest) servletRequest.getMethod())) {
        response.setStatus(HttpServletResponse.SC_OK);
      } else {
         filterChain.doFilter(servletRequest, response);
      }

    }

    @Override
    public void destroy() {

    }
}

ここでは、サーブレット フィルターを有効にする方法を示します。

<filter>
  <filter-name>CorsFilter</filter-name>
  <filter-class>org.apache.catalina.filters.CorsFilter</filter-class>
</filter>
<filter-mapping>
  <filter-name>CorsFilter</filter-name>
  <url-pattern>/swaggerJsonEndpoint/*</url-pattern>
</filter-mapping>
于 2019-03-31T08:55:56.957 に答える