Swagger UI in prod mode

[ShaneCullinane]

Hi,
I'm new to Quarkus, I hope I've correctly read the docs... any advice much appreciated
I've added swagger-ui to my app and I want it available in all environments, not just in dev mode. My understanding is that I should add quarkus.swagger-ui.always-include=true to my properties which I have done.

If I run the app with mvn quarkus:dev I can see in the logs that swagger-ui and openapi are included in the installed features and the /swagger-ui and /openapi endpoints work

[io.quarkus] (Quarkus Main Thread) Installed features: [cdi, micrometer, resteasy, resteasy-jackson, smallrye-context-propagation, smallrye-health, smallrye-openapi, swagger-ui, vertx]

If I run the app with mvn quarkus:run then swagger-ui is not installed and neither the /swagger-ui nor the /openapi endpoints work

[io.quarkus] (main) Installed features: [cdi, micrometer, resteasy, resteasy-jackson, smallrye-context-propagation, smallrye-health, smallrye-openapi, vertx]

Is quarkus:run the right way to replicate locally what happens when the app is in production mode?

My properties are

quarkus.swagger-ui.enable=true
quarkus.swagger-ui.always-include=true
quarkus.swagger-ui.path=/swagger-ui

quarkus.smallrye-openapi.path=/openapi
quarkus.smallrye-openapi.info-title=My API Title
quarkus.smallrye-openapi.info-version=1.0.0

And my pom is below

`

4.0.0
org.myorg
quarko
1.0-SNAPSHOT

<properties>
    <compiler-plugin.version>3.13.0</compiler-plugin.version>
    <maven.compiler.release>17</maven.compiler.release>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
    <quarkus.platform.group-id>io.quarkus.platform</quarkus.platform.group-id>
    <quarkus.platform.version>3.17.7</quarkus.platform.version>
    <skipITs>true</skipITs>
    <surefire-plugin.version>3.5.0</surefire-plugin.version>
</properties>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>${quarkus.platform.group-id}</groupId>
            <artifactId>${quarkus.platform.artifact-id}</artifactId>
            <version>${quarkus.platform.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>io.quarkus</groupId>
        <artifactId>quarkus-arc</artifactId>
    </dependency>
    <dependency>
        <groupId>io.quarkus</groupId>
        <artifactId>quarkus-smallrye-health</artifactId>
    </dependency>
    <dependency>
        <groupId>io.quarkus</groupId>
        <artifactId>quarkus-micrometer-registry-prometheus</artifactId>
    </dependency>
    <dependency>
        <groupId>io.quarkus</groupId>
        <artifactId>quarkus-resteasy</artifactId>
    </dependency>
    <dependency>
        <groupId>io.quarkus</groupId>
        <artifactId>quarkus-resteasy-jackson</artifactId>
    </dependency>
    <dependency>
        <groupId>io.quarkus</groupId>
        <artifactId>quarkus-smallrye-openapi</artifactId>
    </dependency>
    <dependency>
        <groupId>io.quarkus</groupId>
        <artifactId>quarkus-swagger-ui</artifactId>
    </dependency>
    <dependency>
        <groupId>io.quarkus</groupId>
        <artifactId>quarkus-junit5</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>io.rest-assured</groupId>
        <artifactId>rest-assured</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>${quarkus.platform.group-id}</groupId>
            <artifactId>quarkus-maven-plugin</artifactId>
            <version>${quarkus.platform.version}</version>
            <extensions>true</extensions>
            <executions>
                <execution>
                    <goals>
                        <goal>build</goal>
                        <goal>generate-code</goal>
                        <goal>generate-code-tests</goal>
                        <goal>native-image-agent</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>${compiler-plugin.version}</version>
            <configuration>
                <parameters>true</parameters>
            </configuration>
        </plugin>
        <plugin>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>${surefire-plugin.version}</version>
            <configuration>
                <systemPropertyVariables>
                    <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                    <maven.home>${maven.home}</maven.home>
                </systemPropertyVariables>
            </configuration>
        </plugin>
        <plugin>
            <artifactId>maven-failsafe-plugin</artifactId>
            <version>${surefire-plugin.version}</version>
            <executions>
                <execution>
                    <goals>
                        <goal>integration-test</goal>
                        <goal>verify</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <systemPropertyVariables>
                    <native.image.path>${project.build.directory}/${project.build.finalName}-runner
                    </native.image.path>
                    <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                    <maven.home>${maven.home}</maven.home>
                </systemPropertyVariables>
            </configuration>
        </plugin>
    </plugins>
</build>

<profiles>
    <profile>
        <id>native</id>
        <activation>
            <property>
                <name>native</name>
            </property>
        </activation>
        <properties>
            <skipITs>false</skipITs>
            <quarkus.native.enabled>true</quarkus.native.enabled>
        </properties>
    </profile>
</profiles>

`

[quarkus-bot[bot]]

/cc @MikeEdgar (swagger-ui), @phillip-kruger (swagger-ui)

[MikeEdgar]

@ShaneCullinane I think quarkus:run by itself won't rebuild the project. So, if you've changed your configurations without rebuilding, they won't be in effect it. Try doing mvn clean package first to get a clean build (and you haven't already tried it 😄)

[ShaneCullinane]

Thanks @MikeEdgar I guess I didn't try it because I did just now and I see swagger-ui is now included in the list of installed features but the /swagger-ui/ still returns a 404

[MikeEdgar]

Have you also set quarkus.http.non-application-root-path to something in your configuration? If not, I would expect swagger and openapi to be at /q/swagger-ui and /q/openapi.

[ShaneCullinane]

I hadn't set that property at all though I had set quarkus.swagger-ui.path=/swagger-ui. Anyway, I don't really understand but I ran mvn clean package and quarkus:run again except by double clicking the options in Intellij's maven window instead of command line and it works now, swagger is accessible at /swagger-ui.
Thanks for your help :-)