Swagger配置

本文介绍了Swagger作为API框架的使用,特别是在SpringBoot项目中的集成。内容包括Swagger的配置,如何在dev环境下进行选择性读取接口,创建接口分组,以及如何利用Swagger进行接口测试。通过Swagger,可以实现API文档与代码的同步更新,便于前后端联调和测试。
摘要由CSDN通过智能技术生成

Swagger简介

前后端分离

  • 后端:后端控制层、服务层、数据访问层
  • 前端:前端控制层、视图层
    • 前端伪造数据,json,不需要数据也能跑起来
  • 前后端如何交互===》通过API沟通
  • 前后端相对独立,送耦合
  • 前后端甚至可能部署在不同的服务器上

产生一个问题

  • 前后端集成联调,前后端无法做到即时协商,前端加了字段后端需要更改很多东西

解决方案

  • 指定Schema计划制定的提纲,实时更新最新的API,降低集成风险
  • 早些年使用Word文档
  • 前后端分离
    • 前端要使用数据时要确保数据适合前端界面,如果后端传递来的数据不行,就会产生一些问题,所以之前使用postman工具来测试请求,来查看数据
    • 后端提供接口,需要实时更新最新的消息改动
    • 思想的不统一,前后端容易打架,中途加需求也容易打项目经理,所以程序员要好好锻炼身体,争取打赢

Swagger

  • 号称世界上最流行的API框架
  • API文档与API定义同步更新
  • 代码一更新,api就更新
  • 直接运行,在线测试API接口
  • 支持多种语言

SpringBoot集成Swagger

  • <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
    
    
  • @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
         
    }
    
Swagger是一个开源的规范和工具集,用于设计、构建、文档化和使用RESTful Web服务。使用Swagger可以轻松地创建和维护API文档,并为开发人员、测试人员和其他项目相关人员提供一个统一的界面来查看和测试API。 对于后端开发人员来说,Swagger可以帮助他们更好地设计和构建API,并提供自动生成的API文档。 对于前端开发人员来说,Swagger提供了一个可视化界面,方便他们快速了解和使用后端提供的API接口。 对于测试人员来说,Swagger提供了一个集成测试的平台,可以直接在Swagger界面上对API进行测试和验证。 要配置Swagger,首先需要引入Swagger的依赖库。推荐使用2.7.0版本,因为2.6.0版本存在一些bug。可以在项目的pom.xml文件中添加以下依赖: ``` <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version> </dependency> ``` 然后,在Spring Boot项目中整合Swagger,可以创建一个SwaggerConfig配置类,使用`@EnableSwagger2`注解启用Swagger,并创建一个`Docket` bean来配置Swagger的一些基本信息,如API文档的标题、描述和版本等。可以根据需要添加其他的配置,如选择扫描哪些接口、路径等。 在项目中集成Swagger的具体步骤如下: 1. 引入Swagger的依赖库; 2. 创建一个SwaggerConfig配置类,使用`@EnableSwagger2`注解启用Swagger; 3. 创建一个`Docket` bean来配置Swagger的基本信息; 4. 在controller中使用Swagger的注解来标记API接口; 5. 访问本地链接即可查看和使用Swagger的界面。 在使用Swagger过程中,需要注意以下几个问题: 1. 对于只有一个HttpServletRequest参数的方法,推荐使用`@ApiImplicitParams`注解方式单独封装每一个参数; 2. 默认的访问地址是`ip:port/swagger-ui.html#`,但是在Shiro中,会拦截所有请求,所以需要加上默认访问路径,如`ip:port/context/swagger-ui.html#`,并登录后才能查看; 3. 在GET请求中,参数在Body体里面,不能使用`@RequestBody`注解;在POST请求中,可以使用`@RequestBody`和`@RequestParam`注解; 4. 如果使用`@RequestBody`注解,在controller中必须统一指定请求类型,否则Swagger会生成所有类型的参数; 5. 在生产环境中,不应该对外暴露Swagger界面,可以使用`@Profile`注解指定只在开发、测试和预发布环境中使用。 综上所述,Swagger是一个功能强大的工具,可以帮助开发人员更好地设计、构建和文档化API,提高开发效率和API的可用性。通过合理配置和使用Swagger,可以更好地管理和使用API接口。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* *3* [Swagger基本配置](https://blog.csdn.net/qq_40099908/article/details/131102237)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 100%"] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值