目录
1.什么是Swagger?
2.Swagger的作用?
3.Swagger的使用方法
(1)一般是在Spring Boot项目中进行集成,只需在项目中引入springfox-swagger2和springfox-swagger-ui依赖即可
(2)配置Swaager,作为一个配置文件(这里我把它放在了自定义Config的包下)
(3)使用Swagger2进行接口测试
(4)访问效果
Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化Restful风格的Web服务,是非常流行的API表达工具
Sswagger能够自动生成完善的RESTful API文档,同时并根据后台代码的修改同步更新,同时提供完整的测试页面来调试API
io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2
@Configuration
@EnableSwagger2
public class Swagger2Config {@Beanpublic Docket createRestApi(){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo(){return new ApiInfoBuilder().title("演示项目API").description("演示项目").version("1.0").build();}
}
一次配置,到处使用,不需要背

启动项目访问http://127.0.0.1:8080/swagger-ui.html,即可打开自动生成的可视化测试页面(注意这里端口不一定是8080,根据用户设置的服务端口而定)

可以看到上图涵盖各种方法(Get、Post、Put、Delete...)

同时也涵盖了各种在项目中编写的映射路径

更重要的是,还能在该文档进行测试,类似于Postman的效果,这对于前后端人员交互时,是非常节省人力财力的。