一文快速上手Swagger
创始人
2024-05-03 04:21:35

目录

1.什么是Swagger?

2.Swagger的作用?

3.Swagger的使用方法

(1)一般是在Spring Boot项目中进行集成,只需在项目中引入springfox-swagger2和springfox-swagger-ui依赖即可

(2)配置Swaager,作为一个配置文件(这里我把它放在了自定义Config的包下)

(3)使用Swagger2进行接口测试

(4)访问效果


1.什么是Swagger?

Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化Restful风格的Web服务,是非常流行的API表达工具

2.Swagger的作用?

Sswagger能够自动生成完善的RESTful API文档,同时并根据后台代码的修改同步更新,同时提供完整的测试页面来调试API

3.Swagger的使用方法

(1)一般是在Spring Boot项目中进行集成,只需在项目中引入springfox-swagger2和springfox-swagger-ui依赖即可

        io.springfoxspringfox-swagger22.9.2io.springfoxspringfox-swagger-ui2.9.2

(2)配置Swaager,作为一个配置文件(这里我把它放在了自定义Config的包下)

@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();}
}

一次配置,到处使用,不需要背

(3)使用Swagger2进行接口测试

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

(4)访问效果

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

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

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

相关内容

热门资讯

苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
世界上最漂亮的人 世界上最漂亮... 此前在某网上,选出了全球265万颜值姣好的女性。从这些数量庞大的女性群体中,人们投票选出了心目中最美...
长白山自助游攻略 吉林长白山游... 昨天介绍了西坡的景点详细请看链接:一个人的旅行,据说能看到长白山天池全凭运气,您的运气如何?今日介绍...