Swagger接口文档的配置与使用

1. 新建一个maven项目
2. 配置pom.xml 添加依赖

springfox-swagger2

  		
            io.springfox
            springfox-swagger2
            2.9.2
        

springfox-swagger-ui

 		
            io.springfox
            springfox-swagger-ui
            2.9.2
        

3. 配置 resources 目录下的 spring-mvc.xml文件

4. 配置 web.xml 文件

	
		DispatcherServlet
		org.springframework.web.servlet.DispatcherServlet
		
			contextConfigLocation
			classpath:spring-mvc.xml
		
		1
	
	
		DispatcherServlet
		*.do
		/swagger/*
		/api-docs
	
	
		DispatcherServlet
		*.action
	

5. 添加 配置类 SwaggerConfig

@Configuration
@EnableWebMvc
@EnableSwagger2
public class SwaggerConfig{
    @Bean
    public Docket api() {
        return new Docket(documentationType.SWAGGER_2)
                .select()            .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .build()
                .apiInfo(apiInfo());
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("标题")
                .description("http不对外开放接口")
                .version("1.0.0")
                .termsOfServiceUrl("http://xxx.xxx.com")
                .license("假装这里有license")
                .licenseUrl("http://xxx.xxx.com")
                .build();
    }

}

6. 编写控制器（没有与接口内容对应匹配）

@Api(value = "User控制器")
@RestController
public class HelloController {
    @ApiOperation(value="创建用户", notes="根据User对象创建用户")
    @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
    @RequestMapping(value="hi",method = {RequestMethod.GET})
    public String hi(){
        return "hi";
    }
}

7. 测试
   http://localhost:8089/swagger/swagger-ui.html

   http://localhost:8089/doc.html