文章目录
- 一、前言
- 二、swagger2是什么？
- 三、swagger常用注解
- 四、swagger2使用步骤
一、前言
现在互联网技术开发，前后端分离开发模式已经成为了主流模式，通常情况下后端工程师只需要做好给前端提供数据的API接口就可以了，而前端开发工程师则负责向后端请求数据并渲染页面。
这样做的好处就是后端开发人员只需要关注后端的业务，前端开发人员只需要关注前端的事情；岗位职责变得更加清晰，同时开发效率也大大提升。
在这个时候就出现了一个问题，前后端分离后数据交互的问题，前端开发工程师在去调用后端接口获取数据的时候，是要遵循一定的规则的，比如：传递给后端的参数类型等。这个规则就是我们常说的接口文档，这个文档就定义了前后端数据交互时的规范。
作为一名程序猿，都或多或少地被接口文档折磨过，前端工程师经常抱怨后端给的接口文档与实际情况不一致；后端工程师总觉得太多的接口文档要编写以及维护接口文档会耗费不少精力，经常来不及更新。
理想的状态应该是，编写好的接口文档同时发给前端和后端工程师，大伙按照既定的规则各自开发就OK了。
二、swagger2是什么？
Swagger2是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful 风格的Web 服务
使用Swagger你只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，生成多种语言的客户端和服务端的代码，以及在线接口调试页面等等。这样，如果按照新的开发模式，在开发新版本或者迭代版本的时候，只需要更新Swagger描述文件，就可以自动生成接口文档和客户端服务端代码，做到调用端代码、服务端代码以及接口文档的一致性。
三、swagger常用注解
1）、@Api： 用在请求的类上，例如Controller，表示对类的说明
2）、@ApiModel： 用在类上，通常是实体类，表示一个返回响应数据的信息
3）、@ApiModelProperty： 用在属性上，描述响应类的属性
4）、@ApiOperation： 用在请求的方法上，说明方法的用途、作用
5）、@ApiImplicitParams： 用在请求的方法上，表示一组参数说明
6）、@ApiImplicitParam： 用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
四、swagger2使用步骤
第1步、创建maven工程swagger-demo，并在pom.xml引入依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>pd-parent</artifactId>
<groupId>com.wzy</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>pd-demo</artifactId>
<packaging>pom</packaging>
<modules>
<module>swagger-demo</module>
</modules>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
</project>第2步、创建实体类User和Menu
实体类User
package com.wzy.entity;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@Data
@ApiModel(description = "用户实体")
public class User {
@ApiModelProperty(value = "主键")
private int id;
@ApiModelProperty(value = "姓名")
private String name;
@ApiModelProperty(value = "年龄")
private int age;
@ApiModelProperty(value = "地址")
private String address;
}
实体类Menu
package com.wzy.entity;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@Data
@ApiModel(description = "菜单实体")
public class Menu {
@ApiModelProperty(value="主键")
private int id;
@ApiModelProperty(value = "菜单名称")
private String menuName;
}
第3步、创建UserController和MenuController
UserController
package com.wzy.controller;
import com.sun.org.apache.bcel.internal.generic.RETURN;
import com.wzy.entity.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;
import java.util.ArrayList;
import java.util.List;
@RestController
@RequestMapping("/user")
@Api(tags="用户控制器")
public class UserController {
/**
* 1、查询所有用户
* */
@ApiOperation(value = "查询所有用户",notes = "查询所有用户信息")
@GetMapping("/getAllUser")
public List<User> getAllUser(){
List<User> userList=new ArrayList<>();
return userList;
}
/**
* 2、新增用户
* */
@ApiOperation(value="新增用户",notes="新增用户信息")
@PostMapping("/saveUser")
public String saveUser(@RequestBody User user){
return "ok";
}
/**
* 3、修改用户
* */
@ApiOperation(value="修改用户",notes = "新增用户信息")
@PutMapping("/updateUser")
public String updateUser(@RequestBody User user){
return "ok";
}
/**
* 4、通过id删除用户
* */
@ApiOperation(value="删除用户",notes = "通过用户id删除用户")
@DeleteMapping("/deleteUserById")
public String deleteUserById(int id){
return "ok";
}
/**
* 5、分页查询用户信息
* */
@ApiImplicitParams({
@ApiImplicitParam(name="pageNum",value="页码",required = true,type="Integer"),
@ApiImplicitParam(name="pageSize",value="每页条数",required = true,type = "Integer"),
})
@ApiOperation(value="分页查询用户信息")
@GetMapping(value="page/{pageNum}/{pageSize}")
public String getAllUserByPage(@PathVariable Integer pageNum,@PathVariable Integer pageSize){
return "ok";
}
}
MenuController
package com.wzy.controller;
import com.wzy.entity.Menu;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;
import java.util.ArrayList;
import java.util.List;
@RestController
@RequestMapping("/menu")
@Api(tags = "菜单控制器")
public class MenuController {
/**
* 1、查询所有菜单
* */
@ApiOperation(value="查询所有菜单",notes = "查询所有菜单信息")
@GetMapping("/getAllMenu")
public List<Menu> getAllMenu(){
List<Menu> menuList=new ArrayList<>();
return menuList;
}
/**
* 2、新增菜单
* */
@ApiOperation(value="新增菜单",notes = "新增菜单信息")
@PostMapping("/addMenu")
public String addMenu(@RequestBody Menu menu){
return "OK";
}
/**
* 3、修改菜单
* */
@ApiOperation(value="修改菜单",notes = "修改菜单信息")
@PutMapping("/updateMenu")
public String updateMenu(@RequestBody Menu menu){
return "Ok";
}
/**
* 4、通过id删除菜单
* */
@ApiOperation(value="通过id删除菜单",notes = "通过id删除菜单信息")
@DeleteMapping("/deleteMenuById")
public String deleteMenuById(int id){
return "ok";
}
/**
* 5、分页查询所有菜单
* */
@ApiImplicitParams({
@ApiImplicitParam(name="pageNum",value = "页码",required = true,type="Integer"),
@ApiImplicitParam(name="pageSize",value="每页条数",required = true,type = "Integer"),
})
@ApiOperation(value="分页查询菜单信息")
@GetMapping(value = "page/{pageNum}/{pageSize}")
public String getAllMenuByPage(@PathVariable Integer pageNum,@PathVariable Integer pageSize){
return "Ok";
}
}
第4步、创建配置类SwaggerAutoConfiguration
package com.wzy.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* swagger配置类
* */
@Configuration
@EnableSwagger2
public class SwaggerAutoConfiguration {
//创建用户接口API
@Bean
public Docket createUserRestAPI(){
Docket docket=new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo()).groupName("用户接口组")
.select()
.apis(RequestHandlerSelectors.basePackage("com.wzy.controller"))
.build();
return docket;
}
//创建菜单接口API
@Bean
public Docket createMenuRestAPI(){
Docket docket=new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo()).groupName("菜单接口组")
.select()
.apis(RequestHandlerSelectors.basePackage("com.wzy.controller"))
.build();
return docket;
}
//构建api文档的详细信息
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("API接口文档") //页面标题
.contact(new Contact("wzy","http://www.wzy.com","")) //创建人
.version("1.0") //版本号
.description("API描述") //描述
.build();
}
}
第5步、创建application.yml文件
server:
port: 9000
第6步、创建启动类SwaggerApplication
package com.wzy;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class SwaggerApplication {
public static void main(String[] args) {
SpringApplication.run(SwaggerApplication.class,args);
}
}
第7步、启动SwaggerApplication，访问地址：http://localhost:9000/swagger-ui.html
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
