首页 > 其他分享 >SpringBoot整合OpenAPI 3生成在线接口文档

SpringBoot整合OpenAPI 3生成在线接口文档

时间:2024-04-23 17:44:06浏览次数:25  
标签:SpringBoot docs v3 OpenAPI api ui springdoc 文档 swagger

SpringBoot整合springdoc-openapi,自动生成在线接口文档。

1、引入pom依赖

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.3.0</version>
  </dependency>

2、webconfig里添加排除校验

public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new AuthInterceptor()).excludePathPatterns(getExclude());
}
public String[] getExclude() {
        return new String[]{ "/v3/api-docs", "/v3/api-docs/**", "/swagger-ui.html", "/swagger-ui/**"};
    }

3、配置文件里加配置

springdoc:
  api-docs:
    path: /v3/api-docs
  swagger-ui:
    path: /swagger-ui.html

4、输入url测试

http://localhost:8080/test/v3/api-docs

 

标签:SpringBoot,docs,v3,OpenAPI,api,ui,springdoc,文档,swagger
From: https://www.cnblogs.com/shamo89/p/18153419

相关文章

  • springboot 接口限制访问频率
     1.自定义注解@Target({ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)public@interfaceRateLimit{//默认最大访问次数intvalue()default3;//默认时间窗口(秒)longduration()default60;} 2.创建拦截器处理频率逻辑@Slf4......
  • 批量将excle文档用例转为python脚本
    #-*-coding:utf-8-*-importtimeimportpandasaspdimportosallure_param={"epic":"用例版本名","feature":"用例特性名","story":"用例场景名"}df=pd.read_excel(r'D:\aaaaaa.xlsx......
  • langchain + ollama 实现本地文档搜索
    fromlangchain.document_loadersimportOnlinePDFLoaderfromlangchain.vectorstoresimportChromafromlangchain.embeddingsimportGPT4AllEmbeddingsfromlangchainimportPromptTemplatefromlangchain.llmsimportOllamafromlangchain.callbacks.managerimp......
  • springboot 统计接口耗时及指定时间接口访问次数
     1.使用AOP在不改变原有方法的基础上对接口方法增强,引入依赖<!--引入AOP依赖--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId></dependency><!--引入Redis依赖--><depen......
  • springboot项目找不到符号问题以及模块聚合项目maven插件使用的相关问题 问题如图
    参考:https://www.cnblogs.com/coderxiaobai/p/15005181.html问题:更换maven,清空缓存重新导入依赖依然无效后(1)解决方法:方式一:删除项目中.idea文件夹,重新打开项目,选中jdk版本,重新导入依赖即可。(2)如果不是上述的原因可能是项目是模块聚合项目,原因就是父工程的pom中存在maven插......
  • 推荐一款好用的文档工具:docsify
    docsify是什么docsify可以快速帮你生成文档网站。不同于GitBook、Hexo的地方是它不会生成静态的.html文件,所有转换工作都是在运行时。如果你想要开始使用它,只需要创建一个index.html就可以开始编写文档并直接部署在GitHubPages。编写一些团队内部研发规范、api接口文档......
  • SpringBoot如何优雅的进行参数校验(一)
    SpringBoot如何优雅的进行参数校验一.为什么要进行参数校验在日常的开发过程中,我们常常需要对传入的参数进行校验,比如在web前后端分离项目中,参数校验有两个方面:前端进行参数校验后端进行参数校验那这两种有什么区别呢?只完成一个可不可以呢?答案是不可以的!......
  • 自动生成数据库设计文档,支持多数据源批量生成(Word文档)
       在做项目时通常使用PowerDesigner设计数据库,但在项目完成交付项目给客户的时候常常需要一份Word版本的数据库文档给客户,你不能指望每个客户都会用PowerDesigner,所以基于当前开发数据库生成数据库文档就是最佳选择,如果手动编写数据库文档那将是一件非常痛苦的费力不讨好的......
  • SpringBoot的Cookie sameSite之坑
    https://blog.csdn.net/weixin_38296425/article/details/111941318 CSDN上很多文章给出了解决CookiesameSite坑跨域之坑的解决办法,但是都忽略了一个问题,没有给出相关的依赖,我也是费了不少劲终于找到了解决办法,在这里记录下来。例如下面的代码:@ConfigurationpublicclassT......
  • windows右键菜单新建markdown文档
    typora的官网上有相应的教程[1],就是更改windows的注册表,这样可以直接右键新建markdown文件,就不用朴素地新建txt文件然后再改后缀了,typora给出的注册表是:WindowsRegistryEditorVersion5.00[HKEY_CLASSES_ROOT\.md]@="markdown"[HKEY_CLASSES_ROOT\.md\ShellNew]"NullFil......