iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >SpringBootKnife4j在线API文档框架基本使用
  • 381
分享到

SpringBootKnife4j在线API文档框架基本使用

SpringBootKnife4j在线API文档SpringBootKnife4j 2022-12-08 20:12:26 381人浏览 独家记忆

Python 官方文档:入门教程 => 点击学习

摘要

目录1.Knife4j在线api文档基本使用2.配置API文档信息1.Knife4j在线API文档基本使用 Knife4j是一款基于swagger 2的在线API文档框架。 使用Kn

1.Knife4j在线API文档基本使用

Knife4j是一款基于swagger 2的在线API文档框架

使用Knife4j的基础步骤:

  • 添加依赖
  • application.properties/application.yml中添加配置
  • 项目中添加配置类

关于依赖项:

<!-- Knife4j Spring Boot:在线API -->
<dependency>
    <groupId>com.GitHub.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.9</version>
</dependency>

注意:以上依赖项的版本是2.0.9,适用于Spring Boot 2.6以下(不含2.6)版本。

关于配置文件中的配置,主要是开启此框架的增强模式(Knife4j定义的概念),需要添加:

knife4j.enable=true

关于配置类:

import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
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.EnableSwagger2Webmvc;

@Slf4j
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {
    
    private String basePackage = "cn.tedu.csmall.product.controller";
    
    private String groupName = "product";
    
    private String host = "Http://java.tedu.cn";
    
    private String title = "商城在线API文档--商品管理";
    
    private String description = "商城在线API文档--商品管理";
    
    private String termsOfServiceUrl = "http://www.apache.org/licenses/LICENSE-2.0";
    
    private String contactName = "Java教学研发部";
    
    private String contactUrl = "http://java.tedu.cn";
    
    private String contactEmail = "java@tedu.cn";
    
    private String version = "1.0.0";
    @Autowired
    private OpenApiExtensionResolver openApiExtensionResolver;
    public Knife4jConfiguration() {
        log.debug("创建配置类对象:Knife4jConfiguration");
    }
    @Bean
    public Docket docket() {
        String groupName = "1.0.0";
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .host(host)
                .apiInfo(apiInfo())
                .groupName(groupName)
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build()
                .extensions(openApiExtensionResolver.buildExtensions(groupName));
        return docket;
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .termsOfServiceUrl(termsOfServiceUrl)
                .contact(new Contact(contactName, contactUrl, contactEmail))
                .version(version)
                .build();
    }
}

注意:务必检查以上配置类中的basePackage属性的值,必须是当前项目中控制器类所在的包!

在项目中已经完成以上步骤后,启动项目,打开浏览器,通过http://localhost:8080/doc.html即可访问在线API文档。

2.配置API文档信息

@Api:添加在控制器类上

  • 此注解的tags属性,可配置模块名称,可以在模块名称中使用编号,例如:01. 品牌管理模块,最终将按照编号升序排列

@ApiOperation:添加在控制器类中处理请求的方法上

  • 此注解的value属性,可配置业务名称

@ApiOperationSupport:添加在控制器类中处理请求的方法上

  • 此注解的order属性(int类型),可配置业务的排序序号,最终将升序排列

@ApiModelProperty:添加在POJO类型的属性上

  • 此注解的value属性,可配置参数名称(说明)
  • 此注解的required属性,可配置是否必须提交此参数
  • 此注解的example属性,可配置此请求参数的示例值

@ApiImplicitParam:添加在控制器类中处理请求的方法上,用于对未封装的请求参数添加说明(例如Long id参数)

  • 必须配置此注解的name属性,取值为方法的参数名称,表示当前注解对哪个参数进行说明
  • 此注解的value属性,可配置参数名称(说明)
  • 此注解的required属性,可配置是否必须提交此参数
  • 此注解的dataType属性,可配置参数的数据类型(例如取值为"long"
  • 此注解的example属性,可配置此请求参数的示例值

@ApiImplicitParams:添加在控制器类中处理请求的方法上,此注解的value属性是@ApiImplicitParam注解的数组类型,当需要使用@ApiImplicitParam对多个未封装参数进行说明时,需要将多个@ApiImplicitParam注解的配置作为当前注解的参数

@ApiOperation("删除类别")
@ApiOperationSupport(order = 200)
@ApiImplicitParams({
    @ApiImplicitParam(name = "id", value = "类别ID", required = true, dataType = "long"),
    @ApiImplicitParam(name = "userId", value = "用户ID", required = true, dataType = "long")
})
@PostMapping("/delete")
public void delete(Long userId, Long id) {}

到此这篇关于SpringBoot Knife4j在线API文档框架基本使用的文章就介绍到这了,更多相关SpringBoot Knife4j 内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

--结束END--

本文标题: SpringBootKnife4j在线API文档框架基本使用

本文链接: https://www.lsjlt.com/news/174590.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作