springdoc.swagger-ui.url not working as expected

[crazycatMyopic]

based on this url I should be able to use a custom json file (with the Open 3 specification) but i'm unable to, my code keeps giving me 404 not found. The path placed is correct btw.

why is this feature not working?

[moravcik94]

Hello,
I have same problem,
temporary workaround is to add dependency:

<dependency>
	<groupId>org.webjars</groupId>
	<artifactId>webjars-locator</artifactId>
	<version>0.45</version>
</dependency>

More here: #2204

[uc4w6c]

Your issue is not reproducible.
Please provide a minimal reproducible example that reproduces the problem.

I think that the files placed in resources are probably set to not be published.
For example, it will be private if spring.web.resources.add-mappings is set to false.

[destebanm]

Hi!
I have the same issue with

<dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
      <version>2.1.0</version>
</dependency>

http://localhost:8080/v3/api-docs OK
http://localhost:8080/swagger-ui.html KO 404

I have tried @moravcik94 workaround but it is not working in my case.

Any advice?

Thanks!

[youtae]

I have the same issue in 2.1.0.

now, I solved this issue like this

I added this to my property file

springdoc.packagesToScan=your.package

[elgleidson]

I have similar issue, but with webflux and I'm not using the url property (I have no property at all apart from the @youtae suggestion but even with that it's not working):

<parent>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-parent</artifactId>
   <version>3.0.6</version>
   <relativePath/> <!-- lookup parent from repository -->
</parent>

My dependencies:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>
...
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webflux-api</artifactId>
    <version>2.1.0</version>
</dependency>

http://localhost:8080/v3/api-docs -> OK
http://localhost:8080/swagger-ui.html -> 404
http://localhost:8080/swagger-ui/index.html -> 404
http://localhost:8080/webjars/swagger-ui/index.html -> 404

I've tried @moravcik94 workaround dependency + @youtae property but it is not working in my case.

[elgleidson]

Previously it was working fine:

<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>2.7.11</version>
  <relativePath/> <!-- lookup parent from repository -->
</parent>

Dependencies:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-webflux-ui</artifactId>
    <version>1.7.0</version>
</dependency>

http://localhost:8080/v3/api-docs -> OK
http://localhost:8080/swagger-ui.html -> OK
http://localhost:8080/webjars/swagger-ui/index.html -> OK

[elgleidson]

I've created a reproducible example: https://github.com/elgleidson/springdoc-webflux-issue

[elgleidson]

Sorry guys, I must have copied the dependency wrong 🙈
Wrong:

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webflux-api</artifactId>
    <version>2.1.0</version>
</dependency>

Correct:

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
    <version>2.1.0</version>
</dependency>

It's working with the right dependency.

[crazycatMyopic]

Your issue is not reproducible. Please provide a minimal reproducible example that reproduces the problem.

I think that the files placed in resources are probably set to not be published. For example, it will be private if spring.web.resources.add-mappings is set to false.

@uc4w6c find the minimum reproducible code here https://github.com/crazycatMyopic/issue_2/tree/main
as stated it is not considering my custom json but rather the default generated one

[uc4w6c]

@crazycatMyopic
Thank you.
Please access http://localhost:9090/test/webjars/swagger-ui/index.html

[crazycatMyopic]

@uc4w6c i'm not sure what changes we both might have made, cause for me it's still giving the old one, it is not taking the custom json

[uc4w6c]

@crazycatMyopic
Did you remove the comment below?
#springdoc.swagger-ui.url=/apidocs.json

[GodayMax]

same issue
2023-06-08T02:13:49.969+08:00 WARN 25172 --- [nio-8000-exec-6] o.s.web.servlet.PageNotFound : No mapping for GET /swagger-ui/index.html

[uc4w6c]

displayed using the minimum reproducible code created by the creator of this issue (@crazycatMyopic), so I will close it.
If it still doesn't work, you can open it again.

What other people are commenting on may be different.
Please prepare a separate issue with minimum reproducible code.
or for any question post it on stackoverflow

[crazycatMyopic]

@uc4w6c sorry for late reply's, this is my current properties

server.port=9090
spring.webflux.base-path=/test

#Open Api 3.0
#springdoc.swagger-ui.config-url=/v3/apidocs.json
springdoc.swagger-ui.url=/apidocs.json
#springdoc.swagger-ui.path=/apiDocuments
spring.web.resources.add-mappings=false

I'm still facing the issue, can you please let me know if this is correct?

[crazycatMyopic]

@uc4w6c also i'm unable to reopen the issue, please re open it It's working fine now, please ignore the comments