前言
前后端如何交互:API接口
前后端相互独立,松耦合
前后端甚至可以部署在不同的服务器上
前后端集成联调问题
一、Swagger是什么?
1.号称世界上最流行的Api框架
2.RestFul Api 文档在线自动生成工具=>Api文档与API定义同步更新
3.直接运行,可以在线测试API接口
4.支持多种语言(Java,Php…)
二、使用步骤
1.maven依赖
1.swagger2
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
2.ui
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
2.配置Swagger=> Config
@Configuration
@EnableSwagger2
public class SwaggerConfig {
}
3.配置Swaggerd信息
SwaggerConfig.xml
- Swagger的bean实例Docket,通过配置Docket实例来配置Swaggger
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean //配置docket以配置Swagger具体参数
public Docket docket(){
return new Docket(DocumentationType.SWAGGER_2);
}
}
- 通过apiInfo()属性配置文档信息
//配置文档信息
private ApiInfo apiInfo() {
Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
return new ApiInfo(
"Swagger学习", // 标题
"学习演示如何配置Swagger", // 描述
"v1.0", // 版本
"http://terms.service.url/组织链接", // 组织链接
contact, // 联系人信息
"Apach 2.0 许可", // 许可
"许可链接", // 许可连接
new ArrayList<>()// 扩展
);
}
- Docket 实例关联上 apiInfo()
@Bean
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}
- 重启项目,访问测试 http://localhost:8080/swagger-ui.html 看下效果
4.配置扫描接口
链式操作
总结
提示:这里对文章进行总结:
例如:以上就是今天要讲的内容,本文仅仅简单介绍了pandas的使用,而pandas提供了大量能使我们快速便捷地处理数据的函数和方法。