学生管理系统2.0（3）

配置Swagger

我们已经在Maven中配置了Swagger用于管理接口，所以先进行Swagger的配置。本项目采用了Swagger3.0，配置更加简便，如下：

package pers.lee.sms.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.ArrayDeque;

@Configuration
@EnableOpenApi
public class SwaggerConfig {

    // 配置Docket
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .build();
    }

    // 配置ApiInfo
    private ApiInfo apiInfo() {
        Contact contact = new Contact("Sirius", "", "");
        return new ApiInfo(
                "学生管理系统Api文档",
                "这是对学生管理系统接口的描述文档",
                "1.0 SNAPSHOT",
                "",
                contact,
                "",
                "",
                new ArrayDeque<>()
                );
    }
}

 配置完成后可以通过Application.java启动项目，打开浏览器输入localhost:8080/swagger-ui/index.html跳转，出现如下画面即为成功。

测试

上一章已经进行了数据库连接的测试，本次先进行网络连通的测试。

在UesrController中添加新接口：

package pers.lee.sms.controller;


import io.swagger.annotations.Api;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RestController;
import pers.lee.sms.entity.User;
import pers.lee.sms.service.IUserService;

import java.util.List;

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author Sirius
 * @since 2022-01-06
 */
@RestController
@RequestMapping("/user")
@Api(tags = "管理员相关接口")
public class UserController {

    @Autowired
    private IUserService userService;

    @GetMapping("/list")
    public List<User> getAllUsers() {
        return userService.getAllUsers();
    }
}

同时修改IUserService接口和UserServiceImpl实现类：

package pers.lee.sms.service;

import pers.lee.sms.entity.User;
import com.baomidou.mybatisplus.extension.service.IService;

import java.util.List;

/**
 * <p>
 *  服务类
 * </p>
 *
 * @author Sirius
 * @since 2022-01-06
 */
public interface IUserService extends IService<User> {

    List<User> getAllUsers();
}

 

package pers.lee.sms.service.impl;

import org.springframework.beans.factory.annotation.Autowired;
import pers.lee.sms.entity.User;
import pers.lee.sms.mapper.UserMapper;
import pers.lee.sms.service.IUserService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

import java.util.List;

/**
 * <p>
 *  服务实现类
 * </p>
 *
 * @author Sirius
 * @since 2022-01-06
 */
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {

    @Autowired
    private UserMapper userMapper;

    @Override
    public List<User> getAllUsers() {
        return userMapper.selectList(null);
    }
}

这个接口的作用是获取user表中的所有数据，重启项目后进入swagger界面。如下操作：

可以看到状态码为200，且返回数据与数据库一致，说明网络连接也是ok的。

下面将所有的返回信息进行统一包装，新增common包，包下新增Result类用于做统一返回结构。

package pers.lee.sms.common;

import com.alibaba.fastjson.JSONObject;
import lombok.Data;

import java.util.Map;

@Data
public class Result {
    private Result() {}

    private Result(Integer code, String description, JSONObject data) {
        this.code = code;
        this.description = description;
        this.data = data;
    }

    // 状态码
    private Integer code;

    // 描述信息
    private String description;

    // 返回信息
    private JSONObject data;

    public static Result ok() {
        return new Result(2000, "成功", new JSONObject());
    }

    public static Result fail() {
        return new Result(5000, "失败", new JSONObject());
    }

    public Result data(String key, Object value) {
        Result result = ok();
        result.data.put(key, value);

        return result;
    }

    public Result data(Map<String, Object> map) {
        Result result = ok();
        result.data.putAll(map);

        return result;
    }
}

 改造UserController的getAllUsers方法，将其返回值包装为统一格式。

    @GetMapping("/list")
    public Result getAllUsers() {
        List<User> userList = userService.getAllUsers();
        return Result.ok().data("userList", userList);
    }

重新启动项目并通过swagger进行测试：

格式已经是我们定义的统一格式了，data中存放数据。