springboot配置swagger(丝袜哥)生成api接口文档

最新推荐文章于 2023-12-22 17:18:10 发布

qq_44855188

最新推荐文章于 2023-12-22 17:18:10 发布

阅读量620

点赞数

本文链接：https://blog.csdn.net/qq_44855188/article/details/111321006

版权

本文档介绍了如何在SpringBoot项目中配置Swagger2，以实现RESTful Web服务的规范、及时和一致的API接口文档。通过导入依赖、创建配置类，并启用Swagger2，开发者可以轻松地在接口文档上进行测试，提高前后端协作效率。

摘要由CSDN通过智能技术生成

前后端分离开发模式中，api文档是最好的沟通方式。
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)
规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)
一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)
可测性 (直接在接口文档上进行测试，以方便理解业务)
配置Swagger2
第一步导入依赖

 <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <scope>provided </scope>
        </dependency