域名访问网站怎么进入,在线制作图片书,在一起做网店的网站的怎么购买,怎么才可以做网站文章目录简述2. 导入依赖3. 创建配置类4. 创建User实体类5. 创建开发接口6. 启动项目简述
Swagger是一款测试文档Api接口#xff0c;具体用法见SpringBoot整合Swagger。而knife4j是对Swagger进一步封装#xff0c;其优化了api文档的界面。官网https://doc.xiaominfo.com/kni…
文章目录简述2. 导入依赖3. 创建配置类4. 创建User实体类5. 创建开发接口6. 启动项目简述
Swagger是一款测试文档Api接口具体用法见SpringBoot整合Swagger。而knife4j是对Swagger进一步封装其优化了api文档的界面。官网https://doc.xiaominfo.com/knife4j/documentation/
2. 导入依赖
新建一个SpringBoot的项目导入需要的依赖
dependencygroupIdcom.github.xiaoymin/groupIdartifactIdknife4j-spring-boot-starter/artifactIdversion3.0.3/version/dependencydependencygroupIdorg.projectlombok/groupIdartifactIdlombok/artifactId/dependencydependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-web/artifactId/dependency3. 创建配置类
package com.gblfy.config;import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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;Configuration
EnableKnife4j
public class Knife4jConfig {Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).useDefaultResponseMessages(false).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage(com.gblfy.controller)).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().description(Swagger3接口文档).contact(new Contact(哈哈, https://gblfy.com, gblfyqq.com)).version(v1.1.0).title(适用于前后端分离统一的接口文档).build();}
}
4. 创建User实体类
package com.gblfy.entity;import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;Data
ApiModel(value 用户实体)
public class User {ApiModelProperty(value id)private Integer id;ApiModelProperty(value 用户名)private String username;ApiModelProperty(value 性别0男1女)private Integer sex;}5. 创建开发接口
package com.gblfy.controller;import com.example.demo.User;
import io.swagger.annotations.*;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.annotations.ApiIgnore;RestController
Api(tags 用户接口)//描述UserController的信息
public class UserController {ApiOperation(value 查询用户,notes 根据id查询用户)ApiImplicitParam(paramType path,nameid,value 用户id,required true)GetMapping(/user/query/{id})public String getUserById(PathVariable Integer id) {return /user/id;}ApiResponses({ApiResponse(code200,message删除成功),ApiResponse(code500,message删除失败)})ApiOperation(value 删除用户,notes 根据id删除用户)DeleteMapping(/user/delete/{id})public Integer deleteUserById(PathVariable Integer id) {return id;}ApiOperation(value 添加用户,notes 添加一个用户传入用户名和性别)ApiImplicitParams({ApiImplicitParam(paramType query,nameusername,value 用户名,required true,defaultValue 张三),ApiImplicitParam(paramType query,namesex,value 性别,required true,defaultValue 女)})PostMapping(/user)public String addUser(RequestParam String username,RequestParam String sex){return username,sex;}ApiOperation(value修改用户,notes 根据传入的用户信息修改用户)PutMapping(/user)public String updateUser(RequestBody User user){return user.toString();}GetMapping(/ignore)ApiIgnorepublic void ignoreMethod(){}}6. 启动项目
测试。启动项目在浏览器输入http://localhost:8080/doc.html就可以看到接口的信息展开接口就能看到所有的接口详细信息
展开后可以对各个请求进行测试。选择接口后点击调试输入相关的参数点击发送按钮即可。
