SpringBoot Swagger2 rest API文档未加载

Question

我正在尝试获取我在Spring中编写的包含swagger2的小型REST API的文档。当我尝试访问我的招摇页面时，浏览器控制台中会显示以下错误。

Whitelabel Error Page

This application has no explicit mapping for /error, so you are seeing this as a fallback.

Mon Sep 25 21:09:08 IST 2017
There was an unexpected error (type=Not Found, status=404).
No message available

我的代码片段如下所示。

    package com.example.demo;

import java.util.Collections;
import java.util.List;

import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

@RestController
@RequestMapping(value="/rooms")
@Api(value="rooms", tags=("rooms"))
public class RoomController {

    @Autowired
    private RoomRepositery roomRepo;

    @RequestMapping(method = RequestMethod.GET)
    @ApiOperation(value="Get All Rooms", notes="Get all rooms in the system", nickname="getRooms")
    public List<Room> findAll(@RequestParam(name="roomNumber", required=false)String roomNumber){
        if(StringUtils.isNotEmpty(roomNumber)) {
            return Collections.singletonList(roomRepo.findByRoomNumber(roomNumber));
        }
        return (List<Room>) this.roomRepo.findAll();
    }
}

App class

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import static springfox.documentation.builders.PathSelectors.any;

@SpringBootApplication
@EnableSwagger2
public class RoomServiceApp {

    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("Room").select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo"))
                .paths(any()).build().apiInfo(new ApiInfo("Room Services",
                        "A set of services to provide data access to rooms", "1.0.0", null,
                        new Contact("Frank Moley", "https://twitter.com/fpmoles", null),null, null));
    }

    public static void main(String[] args) {
        SpringApplication.run(RoomServiceApp.class, args);
    }
}

我无法找到我在这里失踪的东西。任何人都可以帮助我吗？

由于

Answer 1

您必须使用http://localhost:9090/swagger-ui.html作为swagger UI，使用http://localhost:9090/v2/api-docs?group=Room作为JSON API。

我使用相同的代码并找到附带的屏幕截图。

请参阅this项目了解更多详情。

Answer 2

方法级别的请求映射应具有如下所示的 URI 路径，用于 findAll 方法。如果有传递给方法的输入和从方法返回的输出，则消费和生产也是必需的。

原因是方法级别的空映射值将导致 'host:port/contextPath/' swagger 将返回 404。

@RequestMapping(method = { RequestMethod.GET }, value = "/roomList", consumes = {
        MediaType.ALL}, produces = { MediaType.ALL})