Springboot之Swagger用途与配置

最新推荐文章于 2024-09-25 21:23:51 发布

Mickle_zhang

最新推荐文章于 2024-09-25 21:23:51 发布

阅读量868

点赞数

分类专栏： Spring-Cloud 文章标签： Swagger

本文链接：https://blog.csdn.net/Mickle_zhang/article/details/88389957

版权

本文介绍了Swagger的基本概念，它是一个用于书写API文档的框架，提供RESTful服务的描述、生产和可视化。接着详细讲解了如何在Springboot项目中配置Swagger，包括在pom.xml添加依赖、创建配置文件，以及如何通过http://localhost:8999/swagger-ui.html进行接口测试和导出API文档。更多内容敬请期待。

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

一：swagger是什么？

1、是一款让你更好的书写API文档的规范且完整框架。
2、提供描述、生产、消费和可视化RESTful Web Service。
3、是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面。

二：配置Swagger

1、在pom.xml文件中添加swagger相关依赖

第一个是API获取的包，第二是官方给出的一个ui界面。

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

2、swagger的configuration

新增swagger配置文件，与springboot启动文件放在同一文件夹