第一步添加依赖

     <!--添加swagger的依赖--><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.7.0</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.7.0</version></dependency>

第二步添加配置

①新建一个config包，写配置类

package com.qiu.config;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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;//表示这个类是一个配置类,会把这个类注入到ioc容器中
@Configuration
//开启swagger2的功能
@EnableSwagger2
public class SwaggerConfig {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()//这里一定要标注你控制器的位置.apis(RequestHandlerSelectors.basePackage("com.qiu.controller")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("Thymeleaf测试").description("SpringBoot整合Thymeleaf测试").termsOfServiceUrl("https://angegit.gitee.io/myblog/").contact(new Contact("niechangan","https://angegit.gitee.io/myblog/","1351261434@qq.com")).version("1.0").build();}
}

②加入api注解，在controller类上面

③每个方法上加入@ApiOperation注解，生成对应api

    //value 简单描述，notes 详细描述@ApiOperation(value = "删除用户",notes = "根据id删除用户")@DeleteMapping("/deleteById")public boolean deleteById( Integer id){boolean b = userService.removeById(id);return b;}

第三步在线测试接口

重启项目打开网页进入访问地址

访问地址：http://localhost:8080/swagger-ui.html

注：端口号要写自己的

出现此页面表示成功

展开查看详情

输入要查询的名字测试

结果

Swagger接口文档相关推荐

sentinel 官方文档_SpringCloud网关聚合Swagger接口文档实践
目前大多数项目都是以微服务架构设计,以前后端分离技术解耦前端开发工程师和后端开发工程师的工作量,这样一来前后端的对接将是一项重要的沟通工作量,如果后端没有一个合适的API文档,那么这样的前后端对接将是 ...
swagger接口文档使用
swagger接口文档一,swagger简介前后端分离 swagger 诞生二,springboot集成swagger 依赖编写helloworld接口配置swagger ==> co ...
springboot 接口文档请求 enum_Spring Boot集成SpringFox 3：生成Swagger接口文档
SpringFox介绍 SpringFox是一个开源的API Doc的框架, 它的前身是swagger-springmvc,可以将我们的Controller中的方法以文档的形式展现.官方定义为:Aut ...
整合Swagger接口文档
Swagger接口文档:自动生成接口文档 1.添加依赖: <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagg ...
自动生成python接口文档_Django自动生成Swagger接口文档
Django自动生成Swagger接口文档 1. 前言当接口开发完成,紧接着需要编写接口文档.传统的接口文档通常都是使用Word或者一些接口文档管理平台进行编写,但此类接口文档维护更新比较麻烦,每次 ...
swagger接口文档出现的空文档问题
记一次使用swagger接口文档出现的空文档问题问题描述: 上面显示的一些空文档下面的才是真正的正确文档: 最终尝试发现问题: 原因:**@Api(value = "ExamPaperC ...
SpringBoot集成knife4j实现Swagger接口文档
前言:如果你是后台开发,提供restful接口给前端,建议你使用Swagger3提供restful的接口文档自动生成和在线接口调试.knife4j是对Swagger进一步封装,其优化了API文档的UI ...
python实现处理swagger接口文档，转换为yaml格式的自动化用例
前言之前有很多小伙伴反馈,希望我出一期将swagger文档转换为 yaml格式的自动化用例,那么本期福利来咯~~这一篇文档,将会带领你们实现如何通过 swagger文档转换为 yaml格式的用例 ...
Python Swagger 接口文档自动集成平台
一安装当前virtualenv 环境下 pip install django-rest-swagger==2.2.0 在Django项目settings.py中加入插件模块 DEBUG = T ...
【愚公系列】2023年02月 WMS智能仓储系统-007.Swagger接口文档的配置
文章目录前言一.Swagger接口文档的配置 1.安装包 2.注入 2.1 Swagger服务的注入 2.2 appsetting.json的配置 2.3 Swagger服务的封装 2.3.1 S ...

Swagger接口文档

第一步添加依赖

第二步添加配置

①新建一个config包，写配置类

②加入api注解，在controller类上面

③每个方法上加入@ApiOperation注解，生成对应api

第三步在线测试接口

重启项目打开网页进入访问地址

出现此页面表示成功

展开查看详情

输入要查询的名字测试

结果

Swagger接口文档相关推荐

最新文章

热门文章