swagger打开报错:No API definition provided解决方案

直接看图:

首先保证你swagger基本配置已配置好,有相关的注解都已写好,但是打开之后出现: No API definition provided

解决方案(自己遇到的,你可以尝试,但并不代表一定是适合你当前):

在创建API的时候,有指定  DocumentationType:

 将 DocumentationType改为:DocumentationType.SWAGGER_2

 

或者 DocumentationType.OAS_30 试试

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger UI是一款RESTFUL接口的文档在线自动生成 功能测试功能软件。       现在多数的项目开发中,网站和移动端都需要进行数据交互和对接,这少不了使用REST编写API接口这种场景。例如有些团队,移动端交由了另一团队开发,不同开发小组之间就需要以规范和文档作为标准和协作基础。良好的文档可以让开发事半功倍,而作为又懒又要效率又能交代的码农,当然最希望一 切自动化,或用小聪明来找到最适合的工具。       Swagger-UI简单而一目了然。它能够纯碎的基于html javascript实现,只要稍微整合一下便能成为方便的API在线测试工具。       项目的设计架构中一直提倡使用TDD(测试驱动)原则来开发,swagger-ui在这方面更是能提供很大帮助。 Swagger-UI更倾向于在线测试接口和数据,但其核心是一个javascript插件,只要稍作修改,便能按需求定制出不同格式的说明文档,在github上更是基于它集成到各种语言环境,分支众多。        其官方提供了一个离线版本,它的使用方法十分简单:直接在js格式的资源文件中录入REST API的json信息,便能容易地生成不同模块下的API列表,每个API接口描述和参数、请求方法都能在每个json数组中定制。下面是目前项目中使用到的部分预览图:  Swagger-UI 的官方地址: http://swagger.wordnik.com Github上的项目地址: https://github.com/wordnik/swagger-ui 官方提供的demo地址 http://petstore.swagger.wordnik.com/ 标签:api
当我们在使用Swagger时出现"No API definition provided"的误通常是因为Swagger没有找到API定义。这个误可能由以下几个原因引起: 1. 缺少Swagger注解:在代码中,我们需要使用Swagger的注解来标识API的定义。缺少这些注解会导致Swagger无法正确识别API。我们需要确保在需要暴露的API方法或类上添加正确的Swagger注解。 2. 缺少Swagger配置文件:Swagger通常需要一个配置文件来指示它在哪里寻找API的定义。如果缺少配置文件或配置文件没有正确设置,Swagger将无法找到API定义。我们需要确保Swagger的配置文件存在,并且包含正确的API定义路径。 3. 未正确启动Swagger:在使用Swagger之前,我们需要将它正确地集成到我们的应用程序中。这可能包括添加Swagger依赖项、配置Swagger的启动类或配置文件,并确保正确启动。如果Swagger没有正确启动,它将无法找到API定义。 为了解决这个问题,我们可以采取以下几个步骤: 1. 检查代码中的Swagger注解:确保在需要暴露的API方法或类上使用了正确的Swagger注解,如@Api、@ApiOperation等。 2. 检查Swagger配置文件:检查Swagger的配置文件是否存在,并确保其中包含正确的API定义路径。 3. 检查Swagger的启动过程:确保Swagger正确地集成到应用程序中,并正确启动。检查Swagger的配置类或配置文件,并确保它们被正确加载和启用。 通过这些步骤,我们应该能够解决"No API definition provided"的误,并让Swagger正确识别和展示我们的API定义。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值