Can't access API's documentation with JHipster

Question

I've been trying to access the generated Swagger-UI of a JHipster generated Spring app. I've tried to access through "/swagger-ui.html" as that worked out just fine with other projects, but not this time. I've also looked up the security configuration class and tried all URLs that reference swagger (like "/swagger-ui/index.html") but none of them work: It's response code 404.

I know that the configuration class gets run, because the console shows the "Started Swagger" message, but still no UI.

Any ideas? Any help will be much appreciated. Thanks.

Nope! I actually get redirected to the default error page of JHipster — Unai P. Mendizabal, Nov 13 '16 at 17:27

score 3 · Answer 1 · answered Nov 13 '16 at 21:11

3

To access the Swagger docs on a JHipster app, you need to go login as an admin and click the "API" link in the admin navbar dropdown.

You can also access it directly at http://localhost:8080/#/docs

answered Nov 13 '16 at 21:11

Jon Ruddell

6,244
1
22
40

Hi.. is it possible to easily offer the swagger ui to a normal (ROLE_USER) user ? – 1977 Jul 16 '21 at 11:59

score 2 · Answer 2 · answered Nov 22 '16 at 11:57

2

Have you made sure that the swagger profile is active? Check your config at src/main/resources/config/application-dev.yml

spring:
    profiles:
        active: dev
        include: swagger

or

spring:
    profiles:
        active: dev, swagger

answered Nov 22 '16 at 11:57

Tom Nijs

3,835
3
22
40

score 2 · Answer 3 · answered Sep 17 '19 at 07:34

2

since you are using jhipster, you can find the swagger config @ class SwaggerAutoConfiguration in the jar : jhipster-framework

by default the url is : http://127.0.0.1:8761/swagger-ui/index.html

answered Sep 17 '19 at 07:34

Tiago Medici

1,944
22
22

the default port is 8080 ... unless you changed it. – Samy Omar May 26 '20 at 11:57
JHipster Registry (Netflix Eureka) is 8761 as you can see my screen shot, 8080 is JHipster application back-end development port (Spring Boot server) – Tiago Medici May 26 '20 at 12:04
1

for me, I don't use Netflix Eureka, and swagger works on http://127.0.0.1:8080/swagger-ui/index.html – Samy Omar May 26 '20 at 12:31

user9869932 · Answer 4 · 2020-09-04T23:22:47.690

2

Add this to your build.gradle:

dependencies {
...
compile 'io.springfox:springfox-swagger-ui:2.9.2'

or (maven)

<dependency>
 <groupId>io.springfox</groupId>
 <artifactId>springfox-swagger-ui</artifactId>
 <version>2.9.2</version>
</dependency>

Then you'll be able to reach the UI at

http://localhost:8080/swagger-ui.html

edited Sep 04 '20 at 23:22

answered Sep 03 '20 at 23:12

user9869932

6,571
3
55
49

1

In my case using Gradle: ```implementation "io.springfox:springfox-boot-starter:3.0.0"``` – Luis Ciber Dec 12 '21 at 05:40

score 1 · Answer 5 · answered Nov 13 '16 at 17:59

1

have a look under src/main/webapp/swagger-ui to see what resoures have been generated. Also be sure that you run all gulp build stepts, e.g swagger-ui which is included as a task in the build process for the prod environment.

answered Nov 13 '16 at 17:59

duderoot

977
1
8
23

score 1 · Answer 6 · answered Nov 13 '20 at 07:41

Just created a spring boot JHipster project with v6.10.5. Seems its different now: Login as admin with password admin. Then on the left of the "account" item at the top the "administration" item appears. Beneath click on "API" or just enter http://localhost:8080/admin/docs.

Can't access API's documentation with JHipster

6 Answers6

Linked