如何用Swagger记录Spring Boot webapp的RestController？

Question

@RestController
@Api(description="Querying concepts")
public class KnowledgeModelController {
    private ConceptService conceptService;
    @Autowired
    public KnowledgeModelController(ConceptService conceptService) {
        this.conceptService = conceptService;
    }
    @ApiOperation(value = "Returns a concept identified by its URI, optionally restricted by its branch", response = ConceptService.Concept.class)
    @RequestMapping(value = "/concept", method = RequestMethod.GET)
    public ConceptService.Concept getConcept(Optional<String> branch, String uri) {
        return conceptService.getConcept(branch, uri);
    }
}

这个问题显然可以通过将整个webapp移动到非根上下文路径来解决。但是，我不能走这条路由，因为客户端已经知道并使用它的某些endpoint。

如何让springfox和swagger在这种情况下工作呢？

Answer 1

我找到的解决方案实现了以下策略：

1. 将新的RestController映射到非根上下文路径/RESTPath。这也将使springfox在/restpath/v2/api-docs处公开其endpoint。
2. 让所有Swagger资源出现在/restpath下，而不是出现在/，这样从/restpath/swagger-ui.html到/restpath/v2/api-docs的导航就可以工作了。

为了执行第一个操作，我只需向RestController类添加一个@RequestMapping（“/RestPath”）注释。

@Configuration
public class MvcConfig extends WebMvcConfigurerAdapter {
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        super.addViewControllers(registry);
        registry.addRedirectViewController("/restpath/v2/api-docs", "/v2/api-docs").setKeepQueryParams(true);
        registry.addRedirectViewController("/restpath/swagger-resources/configuration/ui","/swagger-resources/configuration/ui");
        registry.addRedirectViewController("/restpath/swagger-resources/configuration/security","/swagger-resources/configuration/security");
        registry.addRedirectViewController("/restpath/swagger-resources", "/swagger-resources");
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/restpath/**").addResourceLocations("classpath:/META-INF/resources/");
    }
}