springboot集成swagger3与knife4j的详细代码

目录
  • springboot集成swagger3
    • swagger3的springboot启动器jar包
    • 编写TestController代码
    • 创建Swagger3Configuration
    • 运行演示
    • 对接口进行注解
      • swagger中常用的注解
      • 接口基本使用
      • 运行结果
    • 集成更好的UI-knife4j
      • maven
      • 启动器

springboot集成swagger3

swagger3的springboot启动器jar包

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

注意:当前SpringBoot版本为2.5.6,Swagger3.0目前无法完全兼容SpringBoot2.6.x!

编写TestController代码

@RestController
@RequestMapping("test")
public class TestController {
    @GetMapping
    public Map<String, Object> get(@RequestParam String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @PostMapping
    public Map<String, Object> post() {
        Map<String, Object> r = new HashMap<>(1);
        r.put("code", 200);
        return r;
    }
    @PutMapping
    public Map<String, Object> put(String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @DeleteMapping
    public Map<String, Object> delete(String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }
}

创建Swagger3Configuration

@Configuration
@EnableOpenApi
public class SwaggerConfig {
    private static final String VERSION = "0.0.1";
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .groupName("分组名称")
                .apiInfo(apiInfo())
                .select()
                //要扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 设置标题
                .title("文档标题")
                //联系人
                .contact(contact())
                //描述
                .description("xxx文档")
                //服务
                .termsOfServiceUrl("https://spring.io/")
                //许可证
                .license("Apache 2.0")
                .licenseUrl("https://www.apache.org/licenses/LICENSE-2.0")
                .version(VERSION)
                .build();
    }
    private Contact contact (){
        return new Contact("SpringBoot", "https://spring.io/", "email");
    }
}

运行演示

访问网址:http://127.0.0.1:8081/swagger-ui/index.html

对接口进行注解

swagger中常用的注解

注解 作用 使用位置
@Api 表示对类的说明常用参数
@ApiOperation 说明方法的用途 方法
@ApiImplicitParams 里面可以包含多个@ApiImplicitParam 方法
@ApiImplicitParam 描述参数的用途 方法
@ApiModel 表示一个数据类的信息
@ApiModelProperty 描述数据类的属性 属性
@ApiIgnore 忽略某个字段使之不显示在文档中 属性

接口基本使用

1.新建一个用户实体类

@ApiModel("用户")
@Data
public class User {
    @ApiModelProperty("用户名")
    private String username;
    @ApiModelProperty("密码")
    private String password;
}

2.给TestController添加注解

@Api(tags = "测试接口")
@RestController
@RequestMapping("test")
public class TestController {
    @ApiOperation("get请求")
    @GetMapping
    @ApiImplicitParam(name = "id", value = "测试用id", dataTypeClass = String.class)
    public Map<String, Object> get(@RequestParam String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @ApiOperation("post请求")
    @PostMapping
    public Map<String, Object> post(@RequestBody User user) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("code", 200);
        return r;
    }

    @ApiOperation("put请求")
    @PutMapping
    @ApiImplicitParam(name = "id", value = "put请求id", dataTypeClass = String.class)
    public Map<String, Object> put(String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @ApiOperation("delete请求")
    @DeleteMapping
    @ApiImplicitParam(name = "id", value = "delete请求id", dataTypeClass = String.class)
    public Map<String, Object> delete(String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }
}

运行结果

集成更好的UI-knife4j

maven

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-micro-spring-boot-starter</artifactId>
   <version>3.0.3</version>
</dependency>

启动器

在SwaggerConfig类上添加**@EnableKnife4j**

@Configuration
@EnableOpenApi
@EnableKnife4j
public class SwaggerConfig 

访问网站:http://127.0.0.1:8080/doc.html#/home

到此这篇关于springboot集成swagger3与knife4j的文章就介绍到这了,更多相关springboot集成swagger3内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • Springboot集成knife4j实现风格化API文档

    POM引入插件 <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <!--在引用时请在maven中央仓库搜索最新版本号 --> <version>2.0.3</version> </dependency> 配置加载 package com.p

  • SpringBoot集成Swagger3的实现

    目录 一,什么是swagger? 二,SpringBoot 集成swagger3 三,swagger3 注解标签使用 一,什么是swagger? 1,  Swagger 是一个规范和完整的文档框架,     用于生成.描述.调用和可视化 RESTful 风格的 Web 服务文档     官方网站:https://swagger.io/ 2,使用swagger要注意的地方:      在生产环境中必须关闭swagger,      它本身只用于前后端工程师之间的沟通,      可以专门使用一台内

  • springboot2.6.4集成swagger3.0遇到的坑及解决方法

    Swagger简介 号称:世界上最流行的API框架 PestFul API文档在线自动生成器 --> API文档与API定义同步更新可以直接运行,测试API接口 支持多种语言 强调:我的springboot版本2.6.4,swagger为3.0,其他版本可能修改不成功,大家可以试试. 在集成的时候出现了很多问题 坑一:首先先排除问题 ,我使用的springboot版本2.6.4,导入的swagger依赖如下 <dependency> <groupId>io.springfox

  • 关于springboot集成swagger及knife4j的增强问题

    参考链接:狂神的Swagger笔记 号称世界上最流行的API框架 Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新 直接运行,在线测试API 支持多种语言 (如:Java,PHP等) 官网:swagger SpringBoot集成Swagger 添加maven依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2&

  • 关于springboot集成swagger3时spring-plugin-core报错的问题

    springboot集成knife4j的时候3.0.2版本出现了以下问题: An attempt was made to call a method that does not exist. The attempt was made from the following location:       springfox.documentation.schema.plugins.SchemaPluginsManager.viewProvider(SchemaPluginsManager.java

  • springboot集成swagger3与knife4j的详细代码

    目录 springboot集成swagger3 swagger3的springboot启动器jar包 编写TestController代码 创建Swagger3Configuration 运行演示 对接口进行注解 swagger中常用的注解 接口基本使用 运行结果 集成更好的UI-knife4j maven 启动器 springboot集成swagger3 swagger3的springboot启动器jar包 <!-- https://mvnrepository.com/artifact/io.

  • SpringBoot集成极光推送完整实现代码

    目录 1.pom.xml 2.application.yml 3.MyJPushClient 4.test 工作中经常会遇到服务器向App推送消息的需求,一般企业中选择用极光推送的比较多,在集成极光时发现极光的文档并不完整,网上的文章也很多不能直接使用,这里列出我在工作中集成极光的全部代码,只需要按照如下代码保证一次性实现. 1.pom.xml <!-- 极光推送 begin --> <dependency> <groupId>cn.jpush.api</grou

  • SpringBoot整合Kafka工具类的详细代码

    目录 kafka是什么? 应用场景 kafka是什么? Kafka是由Apache软件基金会开发的一个开源流处理平台,由Scala和Java编写.Kafka是一种高吞吐量的分布式发布订阅消息系统,它可以处理消费者在网站中的所有动作流数据. 这种动作(网页浏览,搜索和其他用户的行动)是在现代网络上的许多社会功能的一个关键因素. 这些数据通常是由于吞吐量的要求而通过处理日志和日志聚合来解决. 对于像Hadoop一样的日志数据和离线分析系统,但又要求实时处理的限制,这是一个可行的解决方案.Kafka的

  • SpringBoot集成RabbitMQ实现用户注册的示例代码

    上一篇已经介绍了什么是rabbitmq以及和springboot集成方法,也介绍了springboot集成邮件的方式,不了解的可以先看以前写的文章. 三者集成 上一篇springboot集成邮件注册的已经介绍了,本篇文章基于这个介绍,我们只需要修改下面几处即可完成3者集成. 实现步骤 添加rabbitmq依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring

  • SpringBoot集成阿里巴巴Druid监控的示例代码

    druid是阿里巴巴开源的数据库连接池,提供了优秀的对数据库操作的监控功能,本文要讲解一下springboot项目怎么集成druid. 本文在基于jpa的项目下开发,首先在pom文件中额外加入druid依赖,pom文件如下: <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi=&qu

  • springboot集成dubbo注解版的示例代码

    工作中用springboot搭建项目,用dubbo做远程调用.springboot提倡注解配置和java配置,本文是基于dubbo最新版本2.6.3,使用注解方式的示例. 本文假定你已经有springboot和dubbo的使用经验. dubbo简介 dubbo是阿里巴巴开源的分布式服务框架,一般使用dubbo的RPC调用.但2016年停止维护,现在使用的2.8.4版本其实是当当维护的dubbox.2017年8月阿里又重启维护dubbo,并从2.5.7版本开始支持注解配置. 准备 此示例使用gra

  • 全网最全SpringBoot集成swagger的详细教程

    目录 一. 接口文档概述 二. SpringBoot集成swagger2 2.1 引入依赖 2.2 引入配置 2.3 给Controller 添加注解 2.4 [404]问题解决 2.5 替换UI 三. SpringBoot集成swagger3 四. swaggerUI 拦截器和跨域冲突处理 五. 写在最后 一. 接口文档概述 swagger是当下比较流行的实时接口文文档生成工具.接口文档是当前前后端分离项目中必不可少的工具,在前后端开发之前,后端要先出接口文档,前端根据接口文档来进行项目的开发

随机推荐