SpringBoot入门教程三--整合Swagger及Restful Api设计规范

本文介绍如何在SpringBoot应用中整合Swagger,实现API文档的自动化,并遵循Restful API设计规范,包括HTTP请求规范和URL设计。通过 Swagger,开发者可以便捷地调试接口,提高开发效率。
摘要由CSDN通过智能技术生成

本文4114字,预计阅读11分钟

前文导读

整合Swagger及Restful Api设计规范

前言

在之前的学习中,无论我们是对第一个“Hello World”还是对自定义参数的接口测试,我们都是通过浏览器地址来访问,这仅限于GET请求,如果是POST或者DELETE请求呢,有小伙本可能会说“我可以用Postman调试”,但是就算是Postman我们也需要手动去输入访问地址,接口多了也很麻烦。
那有小伙伴会问了“说了这么多,你倒是说个解决方案啊?”
别慌,客官里面请,小的马上给您一一道来。

整合Swagger

啥是Swagger

先来看看官网的介(Chui)绍(Bi):
Swagger官网简介
可以看到官网对Swagger的简介就是为了简化API开发。我们可以借助Swagger自动生成接口文档,不仅我们自己调试接口时极为方便,而且在前端找我们联调时,兄弟你可以直接甩出你的Swagger地址让他自己一边玩儿去。是不是很爽,那我们马上开始。

集成Swagger

引入Swagger依赖:

<!--swagger-->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.9.2</version>
</dependency>
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.9.2</version>
</dependency>

在引入依赖后我们就能看到效果:
访问Swagger地址:http://{ip}:{port}/swagger-ui.html#/

虽然功能有了,但这全英文的页面看着还是差点意思,没事,Swagger支持我们自定义配置。接着往下看

配置Swagger

  1. 配置标题信息
    对标题信息的配置
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值