认识并了解Swagger

简介: 认识并了解Swagger

Swagger简介

前后端分离

Vue + SpringBoot

后端时代:前端只用管理静态页面;html ==> 后端 。 模板引擎 JSP ==> 后端是主力

前后端分离时代:

  • 后端:后端控制层,服务层,数据访问层 【后端团队】
  • 前端:前端控制层,视图层 【前端团队】
  • 伪造后端数据,json。已经不存在了,不需要后盾,前端工程依旧能跑起来
  • 前后端如何交互? ===> API
  • 前后端相对独立,松耦合;
  • 前后端设置可以部署在不同的服务器上;

产生一个问题:

  • 前后端集成联调,前端人员和后端人员无法做到,及时协商,尽早解决。最终导致问题集中爆发;

解决方案:

  • 首先制定schema[计划的提纲],实时更新最新API,降低集成的风险;
  • 早些年:制定word计划文档;
  • 前后端分离:
  • 前端测试后端接口:postman
  • 后端提供接口,需要实时更新最新的消息及改动

Swagger

  • 号称是世界上最流行的API框架;
  • RestFul Api 文档再现自动生成工具=> API文档与API定义同步更新
  • 直接运行,可以在线测试API接口
  • 支持多种语言:(Java,PHP)

官网:https://swagger.io/

在项目中使用Swagger需要springbox;

  • Swagger2
  • UI

SpringBoot集成Swagger

  1. 新建一个SpringBoot = web项目
  2. 导入相关依赖

swagger 2

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

swagger ui

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
  1. 编写一个hello工程
  2. 配置Swagger ==> Config
@Configuration
@EnableSwagger2 //开启swagger 2
public class SwaggerConfig {
}
  1. 测试运行


目录
相关文章
|
前端开发 Java API
|
6月前
|
JSON 数据库 数据格式
Swagger 中 allOf 的使用技巧
Swagger 提供了一个名为 allOf 的特性,它是通过扩展已有的数据模型来构造更为复杂的数据结构的有效手段。这一特性主要用于数据模型的继承及属性的组合,有效减少了代码重复,同时增强了代码的可维护性与清晰度。访问 Swagger 官方网站可以获得更多关于Swagger的详细信息。
|
6月前
|
Java API 开发者
Bladex生成Swagger的方法
Bladex生成Swagger的方法
|
6月前
|
JSON 前端开发 Java
Swagger介绍及使用
Swagger介绍及使用
112 2
|
6月前
|
存储 API Go
Hertz 整合swagger
Hertz 整合swagger
87 0
|
前端开发 数据可视化 Java
从零学习Swagger3.0
从零学习Swagger3.0
163 0
|
前端开发 Java API
Swagger详解
Swagger详解
145 0
|
数据可视化 物联网 API
Swagger 学习笔记
Swagger 学习笔记
|
Java API Spring
|
数据可视化 前端开发 Java
swagger的使用
(1)@Api:用在类上,例如Controller,表示对类的说明 (2)@ApiModel:用在类上,通常是实体类,表示一个返回响应数据的信息 (3)@ApiModelProperty:用在属性上,描述响应类的属性 (4)@ApiOperation:用在请求方法上,说明方法的用途、作用 (5)@ApiImplicitParams:用在请求的方法上,表示一组参数的说明 (6)@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
133 0
swagger的使用