在线接口生成-一分钟完成springboot项目整合Swagger2实现自动生成接口文档

类似于 "" 格式的url短网址是用腾讯短链接接口生成的,相较于新浪短链接的广泛应用场景,腾讯短链接更多的是应用于微信中,给大家分享一个腾讯短链接url生成接口,大家试试。

1、在线使用

将API接口地址中 "" 的部分换成需要缩短的长网址,然后直接复制,前往浏览器中粘贴打开即可生成了。

2、接口调用

如果觉得在线生成的操作比较麻烦,或者需要生成的量比较大的话,也可以直接对接程序调用API自动生成。对接方法可参考下方

1、调用api接口时,只需将 “”替换成需要缩短的长网址即可。

2、API接口支持长链接中带参数,当长链接中出现 & 符号时,要用 %26 代替(或者使用url编码格式),否则可能会导致参数丢失。

3、长链接必须要以http(s)://开头,否则可能会导致生成失败或者生成的短网址无法访问等清理。

4、上文提到的API接口,我使用大半年了,一直是比较稳定的,大家可以试试,觉得不错记得收藏一下,以免丢失找不到。

1、生成的短链接,为什么原来的参数没有生效?

答:因为长链接中含有特殊字符,需要使用url编码。

2、接口没有返回结果,是什么情况?

答:有些时候接口返回数据有延迟,超时了会生成失败,就无法返回结果了;或者是因为原链接被封了。

3、生成的短链接有效期是多久?有没有访问次数限制?

答:生成的腾讯短链接都是永久有效的,没有访问次数限制,可以放心使用。

一份好的接口文档能够让接口调用者很清晰的知道如何调用一个API接口,包括请求方式、传参规范、接口返回信息等;也能帮助团队新人快速了解业务。

传统的做法是由开发人员维护一个API接口文档,一般是一个word文档或一个提供接口文档管理的网站。这种做法有很多弊端:文档难以维护、浪费开人员时间、文档难以与接口保持一致等。

Swagger2的出现很好的解决了上述问题,可以实现接口文档实时在线生成,提供在线接口测试功能。唯一的弊端就是对接口程序有侵入,但本人认为还是利大于弊的。

接下来我们将Swagger2整合到springboot项目中,并用swagger-bootstrap-ui对Swagger2进行界面美化,废话不多说,我们开始。。。

在中导入

在中设置swagger2是否开启的开关,关闭后接口文档被关闭,在生产环境部署时就需要关闭接口文档。

1.创建注解,主要用于忽略某些不想生成接口文档的接口。

2.创建配置类,配置Swagger接口文档生成规则和过滤规则。

3.拦截器排除swagger相关资源,新建或修改文件,内容如下。

1.编写内容参考如下

2.注解说明

启动项目,浏览器输入

http://location:8081/

,效果如下。

分享两个超赞的永久短网址api接口(附在线生成工具),便捷生成新浪t.cn短网址,亲测几个月,感觉非常稳定。短域名的应用场景很广,譬如短信营销、微博吸粉、淘宝客、京东商品营销、微信营销、QQ营销、自媒体推广、渠道推广等,都会用到链接缩短的功能,故觉得不错的,可以收藏使用。

蓝鸟短链接是目前国内比较好的长链接缩短服务平台,该网站免费提供 新浪短网址 转化工具、 新浪短链接api ,无需注册会员即可免费转换。在线生成器支持批量缩短功能,接口支持高并发,无调用频率限制,转换后的短链均是永久有效。

新浪短网址生成器:

新浪短网址api接口:

/api/tcn

随着移动SEO的重要性越来越重要,在推广的时候如果把网页链接缩短可以获得更好的访问和收益。快鸟短网址提供了一个便捷的网址压缩工具,用户可以前往该网站免费制作 新浪t.cn短网址 ,同样该站也是支持批量转化的,这对于企业来说,使用起来不仅高效也很便捷。

当然为了满足众多用户的需求,该平台也会提供稳定的api接口,如果觉得手动制作很不方便,也可以注册会员获取接口并调用生成。快鸟短网址以稳定的产品运营和高质量的服务,慢慢地也成为了国内最好的网址缩短服务商之一。

新浪短网址在线生成器:

新浪短链接api接口:

/

PS:

1、如果出现参数丢失的情况,请先将长链接做urlencode编码,再转化器或者调用api缩短生成。

2、上文提及的转化器和接口可以免费制作,且压缩后的短链有效期都是永久的,大家可以放心使用。

3、生成的短链接没有访问量限制,大家可以放心使用。

4、接口本质上是不限制调用频率的,但个人建议开发人员实时请求,不能太快。