Swagger 教程(笔记) Knife4j

目录

MySQL user 表

application.properties

UserController

userMapper

User

UserServiceImpl

IUserService

Swagger教程

Swagger前置配置

第一步：引入依赖，导入Maven坐标

第二步：webConfig配置类中加入 knife4j相关配置

第三步：设置静态资源映射，否则接口文档页面无法访问

Swagger 注解的使用

swagger常用注解

@ApiModel  与  @ApiModelProperty 使用效果

使用前

使用后

@Api  与  @ApiOperation    使用效果

使用前

使用后

@ApiImplicitParams注解  与  @ApiImplicitParam    使用效果

使用前

使用后

Swagger 注解的使用

swagger常用注解

@Tag

@Schema

@Operation

@Parameters

@Parameter

---

假设获取到了整个项目，创建项目相应的结构

MySQL user 表

DROP DATABASE if EXISTS study;
CREATE DATABASE study;
USE study;
CREATE TABLE `users` (
	`id` INT(10) NOT NULL AUTO_INCREMENT,
	`username` VARCHAR(255) NOT NULL COLLATE 'utf8_general_ci',
	`password` VARCHAR(255) NOT NULL COLLATE 'utf8_general_ci',
	`create_time` DATETIME NOT NULL,
	`update_time` DATETIME NOT NULL,
	PRIMARY KEY (`id`) USING BTREE
)
COLLATE='utf8_general_ci'
ENGINE=InnoDB
;
INSERT INTO `users`(`username`,`password`,`create_time`,`update_time`) VALUES("Angindem","abc123456","2024-9-25 22:02:15","2024-9-25 22:02:15");