SpringBoot使用swagger生成api接口文檔的方法詳解

更新時間：2022年10月14日 11:29:37 作者：程序員布歐

在之前的文章中，使用mybatis-plus生成了對應的包，在此基礎上，我們針對項目的api接口，添加swagger配置和注解，生成swagger接口文檔，需要的可以了解一下

前言

在之前的文章中，使用mybatis-plus生成了對應的包，在此基礎上，我們針對項目的api接口，添加swagger配置和注解，生成swagger接口文檔

具體可以查看本站spring boot系列文章：

spring boot項目使用mybatis-plus代碼生成實例

具體例子

maven配置

在使用之前，我們需要添加swagger中maven相關依賴配置

<!--swagger 接口說明文檔框架-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

項目application.yml配置

swagger:
  basePackage: com.lewyon.mybatislewyon #包名
  title: 標題  #標題
  description: lewyon #描述
  version: V1.0  #版本號

以上配置包含了swagger文檔展示的包名，標題以及描述，版本號等信息

springApplication添加swagger注解

在springApplication添加swagger注解之后，項目啟動時，會注入swagger相關配置和代碼，

項目啟動成功之后

服務地址/swagger-ui.html就是當前swagger文檔地址

當前項目是：http://localhost:8080/swagger-ui.html

package com.lewyon.mybatislewyon;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@SpringBootApplication
public class MybatislewyonApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatislewyonApplication.class, args);
    }

}

在控制層添加swagger注解

Api 常用于描述當前Rest的模塊信息

ApiOperation 則是當前方法的信息

package com.lewyon.mybatislewyon.user.controller;


import com.lewyon.mybatislewyon.user.entity.User;
import com.lewyon.mybatislewyon.user.service.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import java.util.List;

/**
 * <p>
 * 前端控制器
 * </p>
 *
 * @author lewyon
 * @since 2022-06-25
 */
@RestController
@RequestMapping("/user")
@Api(value = "用戶", tags = {"用戶操作"})
public class UserController {
    @Autowired
    UserService userService;

    @GetMapping("/list")
    @ApiOperation("用戶列表")
    public List<User> listUser() {
        return userService.list();
    }

    @GetMapping("/getUser/{userId}")
    @ApiOperation("用戶詳情")
    public User getUserById(@PathVariable long userId) {
        return userService.getById(userId);
    }

    @GetMapping("/updateUser/{user}")
    @ApiOperation("更新用戶")
    public boolean updateUserById(User user) {
        return userService.updateById(user);
    }

    @GetMapping("/addUser/{user}")
    @ApiOperation("新增用戶")
    public boolean addUser(User user) {
        return userService.save(user);
    }

    @GetMapping("/deleteUser/{id}")
    @ApiOperation("刪除用戶")
    public boolean delUserById(String id) {
        return userService.removeById(id);
    }

}

到此這篇關于SpringBoot使用swagger生成api接口文檔的方法詳解的文章就介紹到這了,更多相關SpringBoot swagger生成api接口文檔內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: