Как отключить Swagger-UI в производстве (Thorntail)? - PullRequest
Новая
       120

Как отключить Swagger-UI в производстве (Thorntail)?

0 голосов
/ 13 февраля 2019

У меня есть приложение, созданное с помощью Wildfly Swarm (теперь Thorntail), и я интегрировал Swagger с моими REST API для документации, а также использую его для тестирования с Swagger-UI.

Я хотел бы знать, если оновозможно отключить часть Swagger-UI при развертывании моего приложения в производственной среде.Я попытался заглянуть в документацию по чванству, чтобы увидеть, есть ли какие-либо свойства для этого, но не смог найти ни одного.То же самое с документацией Thorntail.

Одним из возможных решений было бы отключение зависимости maven от swagger-ui через профиль maven при сборке jar-файла.Я хотел бы избежать этого, потому что тогда мне понадобится одна банка для производства и одна для разработки.

Я видел много предложений, но они, похоже, специфичны для Spring Boot, например, КакВы выключаете Swagger-UI в производстве

1 Ответ

0 голосов
/ 31 марта 2019

Я бы порекомендовал разместить собственный экземпляр swagger-ui, а не использовать его в thorntail, потому что я считаю swagger-ui инструментом разработки, который я бы не использовал непосредственно в сервисе thorntail.

Если swagger-ui размещен как внешняя автономная служба, и вам нужна только одна установка для всех разработчиков, потому что это всего лишь html и javascript, тогда вам нужно только позаботиться о CORS в вашем сервисе для конечной точки, предоставляющей * / swagger.json,Предоставление swagger.json в производственной среде не должно быть проблемой, потому что это всего лишь документ вашего отдыха API.

См. Следующий пример для реализации фильтра CORS, скопированного из проблемы CORS на Javaвеб-приложение 

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>
...