How to access swagger UI?

[MrOwen]

Awesome project and I'm wanting to extend it using the api! I saw /swagger-ui/**", "/v3/api-docs/** are protected routes and I saw those are the default paths but when I go to these, I just get redirected to the login page. I'm not so up on my knowledge on how spring auth works for this stuff so would love if you had any general direction on how to access the api docs. Thank you!

[adityachandelgit]

You will need to set SWAGGER_ENABLED=true in your docker compose file first and then swagger UI will be available at http://localhost:8080/swagger-ui/index.html

services:
  booklore:
    image: ghcr.io/adityachandelgit/booklore-app:latest
    container_name: booklore
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - **SWAGGER_ENABLED=true** 

[MrOwen]

Awesome, thank you for the info.

For anyone wanting a little additional info if they come across this; the api docs is served from the internal api endpoint, running on 8080 which is different than the application default port of 6060. If you wish you access the api and you are using a reverse proxy, you must expose this additional 8080 port- possibly as a different subdomain. OF COURSE, you are responsible for the security of this endpoint and you obviously should not be exposing it or otherwise making it public. I wasn't able to get the API pulled up on the 6060 port since the nginx config was causing it to redirect to the angular app. Maybe I am doing something wrong when making the request and someone can correct me..