Подтвердить что ты не робот

Обработка нескольких базовых дорожек в swagger

Я использую swagger-ui для предоставления нашей документации для REST API. Внутри у нас есть две разные среды, с которыми jenkin строит проект. Например. swagger.json доступен в обеих средах как: http://www.myhost.com/xyz/rest/swagger.json https://www.myhost2.com/rest/swagger.json

Документация доступна как: http://www.myhost.com/xyz/dist/index.html https://www.myhost2.com/dist/index.html

Шаблон базы данных swagger api в web.xml:

<init-param>       
     <param-name>swagger.api.basepath</param-name>
     <param-value>/rest</param-value>
</init-param>

ВОПРОС: Я пытаюсь использовать функцию "Попробовать" на странице документации. Соответствующий URL-адрес запроса для обоих хостов: http://www.myhost.com/rest/getAUser https://www.myhost2.com/rest/getAUser

Он работает для host2, поскольку он нажимает правильный URL. Однако он должен был поразить http://www.myhost.com/xyz/rest/getAUser для хоста 1, но он нажимает на URL http://www.myhost.com/rest/getAUser.

Есть ли способ указать несколько базовых путей для разных URL-адресов.

Мой swagger-ui html выглядит примерно так.

$(function () {
var href = window.location.href;
var url = href.substring(0, href.lastIndexOf("/dist"));
console.log(url);
// Pre load translate...
if(window.SwaggerTranslator) {
window.SwaggerTranslator.translate();
}
window.swaggerUi = new SwaggerUi({
url: url + "/rest/swagger.json",
dom_id: "swagger-ui-container",
......
......
}
4b9b3361

Ответ 1

Мне удалось решить эту проблему, настроив swagger с помощью BeanConfig вместо использования Servlet в web.xml

Класс BeanConfig:

public class SwaggerBootstrap extends DefaultJaxrsConfig {

    /**
     *
     */
    private static final long serialVersionUID = myAutoGeneratedID;

    @Override
    public void init(ServletConfig config) throws ServletException {

        super.init(config);
        //contextPath will be null for host2 and /xyz for host1.
        String contextPath = config.getServletContext().getContextPath();

        BeanConfig beanConfig = new BeanConfig();
        beanConfig.setVersion("1.0.0");
        beanConfig.setTitle("My API Documentation");
        beanConfig.setSchemes(new String[] {
                "http", "https"
        });
        beanConfig
        .setResourcePackage("com.example.my.rest.api.package");

        beanConfig.setBasePath(contextPath + "/rest");
        beanConfig.setScan(true);
    }
}

и в web.xml:

<servlet>
        <servlet-name>SwaggerBootstrap</servlet-name>
        <servlet-class>my.package.to.SwaggerBootstrap</servlet-class>
        <init-param>
            <!-- This make sure that all resources are scanned whether or not they use Swagger Annotations. 
            https://github.com/swagger-api/swagger-samples/tree/master/java/java-jaxrs-no-annotations -->
            <param-name>scan.all.resources</param-name>
            <param-value>true</param-value>
        </init-param>
        <load-on-startup>2</load-on-startup>
    </servlet>

И я изменил свой pom.xml, чтобы начать использовать последнюю стабильную версию swagger-jersey2-jaxrs:

<dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-jersey2-jaxrs</artifactId>
            <version>1.5.3</version>
        </dependency>