spring - 获取我的 REST API 文档的 Spring Boot Swagger 配置有什么问题？为什么我无法访问文档？

Question

我正在开发一个 Spring Boot 应用程序，我正在尝试配置 Swagger 以自动生成我的 REST 服务文档。

我正在学习本教程:http://www.baeldung.com/swagger-2-documentation-for-spring-rest-api

但我发现做起来有些困难。

基本上我已经在我的 Spring Boot 项目中创建了以下 Java 配置类:

@Configuration
@EnableSwagger2
public class Config {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

我认为这是生成我所有 REST 服务的 Swagger 文档的最小配置。我已将此配置类放在 Application 类(包含启动我的项目的 ma​​in() 方法的类)的同一级别。我认为 Config 类没问题，因为我试图在 api() 方法中加入一个 fork 点，我可以看到它在项目中进入了这个方法启动，所以我认为此配置已加载。

然后在前面的教程中说，要验证我的 REST API Swagger 文档是否已生成，我必须对此 URL 执行 GET 请求:http://localhost:8080/spring-security-rest/api/v2/api-docs

我认为此 URL 与示例项目相关，与我的项目无关。

所以我尝试使用: http://localhost:8080/api-docs

但是这样做我得到了这个错误信息:

Whitelabel Error Page

This application has no explicit mapping for /error, so you are seeing this as a fallback.
Sat Jan 14 16:05:23 CET 2017
There was an unexpected error (type=Not Found, status=404).
No message available

在 IDE 控制台中，我收到以下消息:

[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:865)] [http-nio-8080-exec-4] DispatcherServlet - DispatcherServlet with name 'dispatcherServlet' processing GET request for [/swagger-ui.html]
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getHandlerInternal(AbstractHandlerMethodMapping.java:310)] [http-nio-8080-exec-4] RequestMappingHandlerMapping - Looking up handler method for path /swagger-ui.html
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getHandlerInternal(AbstractHandlerMethodMapping.java:320)] [http-nio-8080-exec-4] RequestMappingHandlerMapping - Did not find handler method for [/swagger-ui.html]
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.handler.AbstractUrlHandlerMapping.lookupHandler(AbstractUrlHandlerMapping.java:190)] [http-nio-8080-exec-4] SimpleUrlHandlerMapping - Matching patterns for request [/swagger-ui.html] are [/**]
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.handler.AbstractUrlHandlerMapping.lookupHandler(AbstractUrlHandlerMapping.java:219)] [http-nio-8080-exec-4] SimpleUrlHandlerMapping - URI Template variables for request [/swagger-ui.html] are {}
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.handler.AbstractUrlHandlerMapping.getHandlerInternal(AbstractUrlHandlerMapping.java:140)] [http-nio-8080-exec-4] SimpleUrlHandlerMapping - Mapping [/swagger-ui.html] to HandlerExecutionChain with handler [ResourceHttpRequestHandler [locations=[ServletContext resource [/], class path resource [META-INF/resources/], class path resource [resources/], class path resource [static/], class path resource [public/]], resolvers=[org.springframework.web.servlet.resource.PathResourceResolver@4e671ef]]] and 1 interceptor
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:951)] [http-nio-8080-exec-4] DispatcherServlet - Last-Modified value for [/swagger-ui.html] is: -1
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.DispatcherServlet.processDispatchResult(DispatcherServlet.java:1044)] [http-nio-8080-exec-4] DispatcherServlet - Null ModelAndView returned to DispatcherServlet with name 'dispatcherServlet': assuming HandlerAdapter completed request handling
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1000)] [http-nio-8080-exec-4] DispatcherServlet - Successfully completed request
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:865)] [http-nio-8080-exec-4] DispatcherServlet - DispatcherServlet with name 'dispatcherServlet' processing GET request for [/error]
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getHandlerInternal(AbstractHandlerMethodMapping.java:310)] [http-nio-8080-exec-4] RequestMappingHandlerMapping - Looking up handler method for path /error
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getHandlerInternal(AbstractHandlerMethodMapping.java:317)] [http-nio-8080-exec-4] RequestMappingHandlerMapping - Returning handler method [public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)]
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:951)] [http-nio-8080-exec-4] DispatcherServlet - Last-Modified value for [/error] is: -1
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.view.ContentNegotiatingViewResolver.getMediaTypes(ContentNegotiatingViewResolver.java:263)] [http-nio-8080-exec-4] ContentNegotiatingViewResolver - Requested media types are [text/html, text/html;q=0.8] based on Accept header types and producible media types [text/html])
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.view.BeanNameViewResolver.resolveViewName(BeanNameViewResolver.java:74)] [http-nio-8080-exec-4] BeanNameViewResolver - No matching bean found for view name 'error.html'
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.view.ContentNegotiatingViewResolver.getBestView(ContentNegotiatingViewResolver.java:338)] [http-nio-8080-exec-4] ContentNegotiatingViewResolver - Returning [org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration$SpelView@50e8ed74] based on requested media type 'text/html'
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.DispatcherServlet.render(DispatcherServlet.java:1251)] [http-nio-8080-exec-4] DispatcherServlet - Rendering view [org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration$SpelView@50e8ed74] in DispatcherServlet with name 'dispatcherServlet'
[DEBUG] 2017-01-14 16:40:05 [org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1000)] [http-nio-8080-exec-4] DispatcherServlet - Successfully completed request

让我感到奇怪的是，我没有为我的文档配置任何与 URL 相关的内容(我不知道是否有标准 URL)。

一些进一步的细节可能对找到解决方案很重要。

我的 REST API 是在 Spring Boot 中由处理请求的 Controller 类实现的，如下所示:

package com.myapp.controller.room;

@RestController
@RequestMapping("/Room")
public class RoomController {

    private static final Logger log = LoggerFactory.getLogger(RoomController.class);

    @Autowired
    private RoomService roomService;

    @Autowired
    private RoomMediaService roomMediaService;

    public RoomController(){
        log.debug("RoomController init");
    }

    /**
     * Ritorna la tipologia di stanza associata ad una stanza
     * @param id dellla stanza di cui si intende reperire le informazioni relative alla sua tipologia
     * @return RoomTipologyDTO contenente le informazioni relative alla tipologia di stanza
     * @throws DataAccessException
     */
    @RequestMapping(value = "/{id}/RoomTipology",
            method = RequestMethod.GET,
            produces = MediaType.APPLICATION_JSON_VALUE)
    public ResponseEntity<RoomTipologyDTO> getRoomTipologyByRoomId(@PathVariable Long id) throws DataAccessException{

        log.debug("getRoomTipologyByRoomId START");

        RoomTipologyDTO result = roomService.getRoomTipologyByRoom(id);

        log.debug("getRoomTipologyByRoomId END");

        return ResponseEntity.ok(result);
    }

    ....................................................................
    ....................................................................
    ....................................................................
}

这是包含启动我的应用程序的 ma​​in() 方法的 Application 类:

@SpringBootApplication
@EntityScan("com.betrivius.domain")
@ComponentScan(lazyInit = true)
@EnableAutoConfiguration
public class Application {

    private static final Logger log = LoggerFactory.getLogger(Application.class);

    public static void main(String[] args)  {
        ConfigurableApplicationContext context = SpringApplication.run(Application.class, args);
        //context.close();

        log.info("Let's inspect the beans provided by Spring Boot:");

        String[] beanNames = context.getBeanDefinitionNames();
        Arrays.sort(beanNames);

        log.info("_______________________________________________________");
        for (String beanName : beanNames) {
            log.info(beanName);
        }

        log.info("main() END");
    }
}

我的一项服务的 URL 示例如下所示:

http://localhost:8080/RoomRate/1/RoomRateOptionList

那么生成我的 Swagger 文档的正确 URL 是什么？或者我错过了什么？我该如何解决这个问题？

Answer 1

尝试在 http://localhost:8080/v2/api-docs 上访问 swagger 文档.它应该工作。我认为您使用的是 swagger 文档的第 2 版。