Swagger2的使用

引入Swagger2依赖

<!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <scope>provided </scope>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <scope>provided </scope>
        </dependency>

创建swagger配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();

    }
    
    private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()
                .title("API文档")
                .description("本文档描述")
                .version("1.0")
                .contact(new Contact("java", "http://asdfsdfad.com", "535734512@qq.com"))
                .build();
    }
}

api模型

例如

@Api(description="讲师管理")
@RestController
@RequestMapping("/admin/")
public class AdminController {

	@Autowired
	private Service Service;

	@ApiOperation(value = "")
	@DeleteMapping("{id}")
	public boolean removeById(
			@ApiParam(name = "id", value = "ID", required = true)
			@PathVariable String id){
		return Service.removeById(id);
	}
}