Swagger + Spring boot 未在 http://localhost:8080/home/swagger-ui.html 中显示 API 端点

Question

我有一个 Spring Boot 应用程序在 jetty + swagger 上运行 当我转到http://localhost:8080/home/swagger-ui.html（见附件）时，我没有看到任何端点规范，即使我写了一个控制器并在那里有一个端点。

我的应用程序代码是：

package com.MyService;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class MyServiceApplication {

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


}

在 pom.xml 我使用：

    <!-- Swagger 2.0 support -->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.8.0</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.8.0</version>
            </dependency>
            <dependency>
                <groupId>javax.xml.bind</groupId>
                <artifactId>jaxb-api</artifactId>
                <version>2.3.0</version>
            </dependency>

我的控制器：

package com.MyService.controller;

import com.MyService.model.RegistrationData;
import io.swagger.annotations.*;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

import javax.validation.Valid;

@Api(value = "register", description = "the registration API")
public interface RegistrationApi {



    @ApiOperation(value = "Register user", nickname = "register", notes = "", authorizations = {
            @Authorization(value = "petstore_auth", scopes = {
                    @AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
                    @AuthorizationScope(scope = "read:pets", description = "read your pets")
            })
    }, tags={ "register", })
    @ApiResponses(value = {
            @ApiResponse(code = 405, message = "Invalid input") })
    @RequestMapping(value = "/register",
            produces = { "application/json", "application/xml" },
            consumes = { "application/json", "application/xml" },
            method = RequestMethod.POST)
    default ResponseEntity<Void> registerUser(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true )
                                              @Valid @RequestBody RegistrationData body) {

        return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
    }

}



------

package com.MyService.controller;


import com.MyService.model.RegistrationData;
import com.MyService.service.RegistrationService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api/v1")
public class RegistrationController implements  RegistrationApi{


    private RegistrationService registrationService;


    @Autowired
    public void setProductService(RegistrationService registrationService) {
        this.registrationService = registrationService;
    }


    @RequestMapping(value = "/register", method = RequestMethod.POST)
    public ResponseEntity registerUser(@RequestBody RegistrationData registrationData){
        //todo call service to rgeister
        return new ResponseEntity("user register successfully", HttpStatus.OK);
    }

}

我的 SwaggerConfig：

package com.MyService.config;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import static springfox.documentation.builders.PathSelectors.regex;
@Configuration
@EnableSwagger2
public class Swagger2Config extends WebMvcConfigurationSupport {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select().apis(RequestHandlerSelectors.basePackage("guru.springframework.controllers"))
                .paths(regex("/product.*")).build();

    }

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");

    }

}

我的招摇文档如下所示：

Answer 1

您可以使用以下内容更改现有代码。基础包必须指向您的控制器基础包，并且 URL 上下文应该是您在控制器中添加的内容之一。

将基础包修改为“com.MyService.controller”，并将“/api/v1”和“/register”添加到路径正则表达式中，

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).select()
            .apis(RequestHandlerSelectors.basePackage("com.MyService.controller"))
            .paths(regex("(/api/v1.*)|(/register.*)")).build();
}

Answer 2

您可以显示/product.* URL，但在您的端点中，没有任何与/product.* 匹配的URL。这就是它不显示任何端点的原因。

如下更改您的代码

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select().apis(RequestHandlerSelectors.basePackage("guru.springframework.controllers"))
            .paths(or(regex("/register.*"),regex("/api/v1.*"))).build();

}

您可以使用regex("/.*") 允许所有端点。