首页 > 其他分享 >knife4j api文档使用说明

knife4j api文档使用说明

时间:2024-04-19 21:44:49浏览次数:25  
标签:knife4j description Copyright api 文档 new swagger

1、引入依赖:

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
            <version>4.5.0</version>
        </dependency>

2、Configuration

@Configuration
public class SwaggerDocConfig {

    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .components(new Components().addSecuritySchemes("basicScheme", new SecurityScheme().type(SecurityScheme.Type.HTTP).scheme("basic"))
                        .addParameters("X-Author", new Parameter().in("header").schema(new StringSchema()).name("X-Copyright-Schema"))
                        .addHeaders("X-Copyright-Start", new Header().description("Source Code Copyright declare").schema(new StringSchema())))
                .info(new Info()
                        .title("title")
                        .version("1.0.0")
                        .description("description")
                        .termsOfService("http://swagger.io/terms/")
                        .license(new License().name("Apache 2.0").url("http://springdoc.org")));
    }

}

3、配置

springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'default'
      paths-to-match: '/**'
      packages-to-scan: com.abc.controller
# knife4j的增强配置,不需要增强可以不配
knife4j:
  enable: true
  setting:
    language: zh_cn

标签:knife4j,description,Copyright,api,文档,new,swagger
From: https://www.cnblogs.com/jiayuan2006/p/18146820

相关文章

  • Apple App Store API 快速获取app综合评分,最新评论
    iDataRiver平台https://www.idatariver.com/zh-cn/提供开箱即用的苹果应用商城appstore数据采集API,供用户按需调用。接口使用详情请参考appleAppStore接口文档接口列表1.获取指定app的基础信息参数类型是否必填默认值示例值描述apikeystring是idr_***......
  • AXIOS的封装拦截以及API接口管理详解
    在我们做vue项目时,使用axios请求数据已经是司空见惯了,它是基于promise的http库,可以运行在浏览器和nodejs中,其实他有很多的优秀特性,例如,请求拦截,响应拦截,以及取消请求,json转换,客户端防御XSRF等,所以尤大大直接推荐我们使用axios库。我们先看axios如何封装,首先我在src下创建requestj......
  • IIS 部署WEBAPI
    ASP.NETCore不再是由IIS工作进程(w3wp.exe)托管,而是使用自托管Web服务器(Kestrel)运行,IIS则是作为反向代理的角色转发请求到Kestrel不同端口的ASP.NETCore程序中,随后就将接收到的请求推送至中间件管道中去,处理完你的请求和相关业务逻辑之后再将HTTP响应数据重新回写到IIS中,最终转达......
  • SQLAlchemy 2.0 中文文档翻译完成
    SqlAlchemy2.0中文文档概述SQLAlchemyUnifiedTutorial建立连接-Engine处理事务和DBAPI处理数据库元数据处理数据使用插入语句使用SELECT语句使用UPDATE和DELETE语句使用ORM进行数据操作处理ORM相关对象进一步阅读SQLAlchemyORMORM快速入门ORM......
  • 比较RPC和RESTful API的优缺点
    RPC和RESTfulAPI是两种不同的远程调用方式,它们各自具有不同的优缺点。RPC的优点包括:高效:RPC使用自定义的通信协议,可以减少报文传输量,提高传输效率。灵活:RPC支持多种语言,不同的编程语言可以方便地调用远程接口。通用:RPC可以基于XML、JSON等标准化的数据格式进行通信,使得不同......
  • NL2SQL技术方案系列(1):NL2API、NL2SQL技术路径选择;LLM选型与Prompt工程技巧,揭秘项目落
    NL2SQL技术方案系列(1):NL2API、NL2SQL技术路径选择;LLM选型与Prompt工程技巧,揭秘项目落地优化之道NL2SQL基础系列(1):业界顶尖排行榜、权威测评数据集及LLM大模型(SpidervsBIRD)全面对比优劣分析[Text2SQL、Text2DSL]NL2SQL基础系列(2):主流大模型与微调方法精选集,Text2SQL经典算法......
  • 界面组件库DevExpress Office File API(WinForms & WPF)v24.1新功能预览
    本文描述了界面组件库DevExpress的OfficeFileAPI(WinForms&WPF)和受Office启发的控件在v24.1中发布的一些功能,并详细介绍了我们当前的抢先体验预览版本v24.1中的内容。DevExpressWPF拥有120+个控件和库,将帮助您交付满足甚至超出企业需求的高性能业务应用程序。通过DevExpress......
  • itchat中文文档
    deflogin(self,enableCmdQR=False,picDir=None,qrCallback=None,loginCallback=None,exitCallback=None):'''像web版微信一样登陆用于登陆-将下载并打开一个二维码-然后记录扫码状态,程序暂停等待你微信确认登陆......
  • 08-接口文档和JWT
    接口文档楔子接口文档对于协调前后端开发非常重要,可以避免因为开发习惯不同而导致的意外情况。在项目中,如果前后端开发各自为战,可能会出现不一致的情况。因此,接口文档可以约束双方,确保他们按照统一的规范进行开发,从而提高协同开发的效率和一致性。规范接口文档一般包括以下内......
  • 【高级RAG技巧】在大模型知识库问答中增强文档分割与表格提取
    前言文档分割是一项具有挑战性的任务,它是任何知识库问答系统的基础。高质量的文档分割结果对于显著提升问答效果至关重要,但是目前大多数开源库的处理能力有限。这些开源的库或者方法缺点大致可以罗列如下:只能处理文本,无法提取表格中的内容缺乏有效的分割策略,要么是一整个文档......