Question

关于在Spring MVC中集成Swagger：

Swagger未显示GET/PUT/POST

的@RequestMapping文档

在我的Spring MVC Rest webservice应用程序中，我有一个Login控制器和一个Student Controller。我刚刚配置了Swagger来生成Rest API文档。参考：http://java.dzone.com/articles/how-configure-swagger-generate

问题：但是，Swagger只显示类级路径，我猜它不会显示类级别@RequestMapping。，忽略方法级别映射。有什么理由？

@Controller
@RequestMapping(value = "/login")
public class LoginController {


@RestController
@RequestMapping(value = "/students/")
public class StudentController {

  @RequestMapping(value = "{departmentID}", method = RequestMethod.GET)
  public MyResult getStudents(@PathVariable String departmentID) {
      // code
  }

  @RequestMapping(value = "student", method = RequestMethod.GET)
  public MyResult getStudentInfo(
        @RequestParam(value = "studentID") String studentID,
        @RequestParam(value = "studentName") String studentName) {
     //code
  }

  @RequestMapping(value = "student", method = RequestMethod.POST)
  public ResponseEntity<Student> updateStudentInfo(@RequestBody Student student) {
       //code
  }

Swagger配置：

@Configuration
@EnableSwagger
public class SwaggerConfiguration {
    private SpringSwaggerConfig swaggerConfig;

    @Autowired
    public void setSpringSwaggerConfig(SpringSwaggerConfig swaggerConfig) {
        this.swaggerConfig = swaggerConfig;
    }

    @Bean
    // Don't forget the @Bean annotation
    public SwaggerSpringMvcPlugin customImplementation() {
        return new SwaggerSpringMvcPlugin(this.swaggerConfig).apiInfo(
                apiInfo()).includePatterns("/.*");
    }

private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfo("my API", "API for my app", "", "contact@localhost.com", "License type",
                "something like a License URL");
        return apiInfo;
    }

输出：

http://localhost:8080/studentapplication/api-docs

{
apiVersion: "1.0",
swaggerVersion: "1.2",
apis: [
{
path: "/default/login-controller",
description: "Login Controller"
},
{
path: "/default/student-controller",
description: "Student Controller"
}
],
info: {
title: "Student API",
description: "API for Student",
termsOfServiceUrl: "StudentApp API terms of service",
contact: "abc@xyz.com",
license: "sometext",
licenseUrl: "License URL"
}
}

更新

你还需要spring config XML文件中的以下配置，如https://github.com/martypitt/swagger-springmvc

中所述

    <!-- to enable the default documentation controller-->
    <context:component-scan base-package="com.mangofactory.swagger.controllers"/>

    <!-- to pick up the bundled spring configuration-->
    <context:component-scan base-package="com.mangofactory.swagger.configuration"/>

    <!-- Direct static mappings -->
    <mvc:resources mapping="*.html" location="/, classpath:/swagger-ui"/>

    <!-- Serve static content-->
    <mvc:default-servlet-handler/>

Answer 1

无论现在看到的输出是什么，我们都不会在此GET/POST/PUT输出中看到swagger UI和JSON方法级别映射。这很好。它只显示类级别路径。

要查看具有GET/POST/PUT方法级别映射的实际Swagger UI以及网址，我们需要要下载此处提供的SwaggerUI：https://github.com/swagger-api/swagger-ui

然后导航到此index.html文件：swagger-ui-master\swagger-ui-master\dist\index.html 在这里，编辑源JSON URL到您的应用程序api-docs URL：

即：

  $(function () {
      window.swaggerUi = new SwaggerUi({
      url: "studentapplication/api-docs",
      dom_id: "swagger-ui-container",
      supportedSubmitMethods: ['get', 'post', 'put', 'delete'],

现在你看到了一切!!!

我只有一步之遥......

Swagger for Spring MVC项目

1 个答案: