后端开发技术补充--Swagger的应用

概要

在后端开发中我们为了使代码更加简洁与易于操作会学习一些技术栈的使用，本文主要讲解如何使用Swagger与一些注解来辅助后端代码的开发。
使代码更加便于去验证，并且提升代码的可读性。

一.Swagger技术

技术概念:
swagger是一个规范和完整的框架，用于生成RestFul风格的web服务(即生成一个特殊风格的web网页，可以用于快捷测试接口是否设置正确),实现了以下功能:
1.使得前后端分离开发更加方便,有利于团队协作。
2.接口文档在线自动生成,减低后端开发人员的工作量。
3.方便快速测试接口的正确性。
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!

技术实现：
1.添加依赖:
在pom.xml添加如下依赖:

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-spring-boot-starter</artifactId
   </dependency>

2.配置类中加入knife4j相关配置
WebMvcConfiguration.java文件

@Bean
    public Docket docket(){
    ApiInfo apiInfo = new ApiInfoBuilder()
                 .title("项目接口文档")
                 .version("2.0")
                 .description()
                 .build();
    Docket docket = new Docket
                 .apiInfo()
                 .select();
    .apis(RequestHandlerSelectors.basePackage("com.sky.controller"))
        .paths(PathSelectors.any())
        .build();
    return docket;
}

3.设置静态资源映射，否则接口文档无法访问
WebMvcConfiguration.java

protected void addResourceHandler(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

四.接口测试
访问路径为 http:/ip:port.doc.html --> http://localhost:8080/doc.html

二.常用注解

注解	说明
@Api	用在类上，例如Controller，表示对类的说明
@ApiModel	用在类上，例如entity，DTO，VO
@ApiModelProperty	用在属性上，描述属性信息
@ApiOperation	用在方法上，例如Controller的方法上，说明方法的用途，作用

EmployeeDTO.java文件

 package com.sky.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.io.Serializable;

@Data
@ApiModel(description = "员工登录时传递的数据模型")
public class EmployeeLoginDTO implements Serializable {

    @ApiModelProperty("用户名")
    private String username;

    @ApiModelProperty("密码")
    private String password;

}

EmployLoginVO.java文件

package com.sky.vo;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(description = "员工登录返回的数据格式")
public class EmployeeLoginVO implements Serializable {

    @ApiModelProperty("主键值")
    private Long id;

    @ApiModelProperty("用户名")
    private String userName;

    @ApiModelProperty("姓名")
    private String name;

    @ApiModelProperty("jwt令牌")
    private String token;

}

EmployeeController文件

package com.sky.controller.admin;

import com.sky.constant.JwtClaimsConstant;
import com.sky.dto.EmployeeLoginDTO;
import com.sky.entity.Employee;
import com.sky.properties.JwtProperties;
import com.sky.result.Result;
import com.sky.service.EmployeeService;
import com.sky.utils.JwtUtil;
import com.sky.vo.EmployeeLoginVO;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

/**
 * 员工管理
 */
@RestController
@RequestMapping("/admin/employee")
@Slf4j
@Api(tags = "员工相关接口")
public class EmployeeController {

    @Autowired
    private EmployeeService employeeService;
    @Autowired
    private JwtProperties jwtProperties;

    /**
     * 登录
     *
     * @param employeeLoginDTO
     * @return
     */
    @PostMapping("/login")
    @ApiOperation(value = "员工登录")
    public Result<EmployeeLoginVO> login(@RequestBody EmployeeLoginDTO employeeLoginDTO) 	{
        //..............

        
    }

    /**
     * 退出
     *
     * @return
     */
    @PostMapping("/logout")
    @ApiOperation("员工退出")
    public Result<String> logout() {
        return Result.success();
    }

}

实现效果

三.小结

在本文中，详细回顾了“苍穹外卖”项目开发过程中所涉及的Swagger技术。通过这些技术的深入学习和实践，我们积累了宝贵的经验。以下是我们从这个项目中学到的一些关键点，这些经验不仅可以帮助我们在当前项目中提高了效率，也为可以为未来的学习和发展打下了坚实的基础。