无法使用 JHipster 访问 API 的文档答案

【问题标题】：Can't access API's documentation with JHipster无法使用 JHipster 访问 API 的文档
【发布时间】：2016-11-13 14:53:04
【问题描述】：

我一直在尝试访问由 JHipster 生成的 Spring 应用程序生成的 Swagger-UI。我尝试通过“/swagger-ui.html”访问，因为这在其他项目中效果很好，但这次不行。我还查看了安全配置类并尝试了所有引用 swagger 的 URL（如“/swagger-ui/index.html”），但它们都不起作用：它的响应代码为 404。

我知道配置类会运行，因为控制台显示“Started Swagger”消息，但仍然没有 UI。

有什么想法吗？任何帮助都感激不尽。谢谢。

【问题讨论】：

可能端口不对。应该是8080
不！我实际上被重定向到 JHipster 的默认错误页面

标签： spring jhipster swagger-ui springfox

【解决方案1】：

要访问 JHipster 应用程序上的 Swagger 文档，您需要以管理员身份登录并单击管理员导航栏下拉菜单中的“API”链接。

您也可以直接通过http://localhost:8080/#/docs访问它

【讨论】：

嗨.. 是否可以轻松地将 swagger ui 提供给普通 (ROLE_USER) 用户？

【解决方案2】：

您是否确保 Swagger 配置文件处于活动状态？在src/main/resources/config/application-dev.yml检查您的配置

spring:
    profiles:
        active: dev
        include: swagger

或

spring:
    profiles:
        active: dev, swagger

【讨论】：

【解决方案3】：

由于你使用的是jhipster，所以可以在jar中找到swagger config@class SwaggerAutoConfiguration：jhipster-framework

默认情况下，网址是：http://127.0.0.1:8761/swagger-ui/index.html

【讨论】：

默认端口是 8080 ... 除非您更改它。
JHipster Registry (Netflix Eureka) 是 8761，你可以看到我的屏幕截图，8080 是 JHipster 应用程序后端开发端口（Spring Boot 服务器）
对我来说，我不使用 Netflix Eureka，而 swagger 在 127.0.0.1:8080/swagger-ui/index.html 上工作

【解决方案4】：

将此添加到您的 build.gradle：

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

或（maven）

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

然后你就可以访问 UI 了

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

【讨论】：

在我使用 Gradle 的情况下：implementation "io.springfox:springfox-boot-starter:3.0.0"

【解决方案5】：

查看 src/main/webapp/swagger-ui 以查看生成了哪些资源。还要确保运行所有 gulp 构建步骤，例如 swagger-ui，它作为任务包含在 prod 环境的构建过程中。

【讨论】：

【解决方案6】：

刚刚使用 v6.10.5 创建了一个 Spring Boot JHipster 项目。现在看来不一样了：以管理员身份登录，密码为 admin。然后在顶部的“帐户”项的左侧，出现“管理”项。点击下方的“API”或直接输入 http://localhost:8080/admin/docs。

【讨论】：