SpringBoot轻松集成Swagger

文章目录

  • 一、简介
  • 二、SpringBoot集成Swagger
    • 第一步:创建一个SpringBoot项目
    • 第二步:引入maven坐标
    • 第三步:写yml
    • 第四步:主启动
    • 第五步:创建SwaggerConfig配置类
    • 第六步:使用swagger注解进行标识和说明
  • 三、注解说明与测试

一、简介

官网:https://swagger.io/

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。简单的说,swagger让我们不在手写接口文档,在前后端分离的情况下,更好维护接口文档
作用
1.在线自动生成接口文档
2.接口测试【再也不需要像之前一样,在Postman中手写访问地址,参数,值,请求方式】

Swagger是一组开源项目,其中主要要项目如下

  1. Swagger-tools:提供各种与Swagger进行集成和交互的工具。例如模式检验、Swagger 1.2文档转换成Swagger 2.0文档等功能。

  2. Swagger-core: 用于Java/Scala的的Swagger实现。与JAX-RS(Jersey、Resteasy、CXF…)、Servlets和Play框架进行集成。

  3. Swagger-js: 用于JavaScript的Swagger实现。

  4. Swagger-node-express: Swagger模块,用于node.js的Express web应用框架。

  5. Swagger-ui:一个无依赖的HTML、JS和CSS集合,可以为Swagger兼容API动态生成优雅文档。

  6. Swagger-codegen:一个模板驱动引擎,通过分析用户Swagger资源声明以各种语言生成客户端代码。

二、SpringBoot集成Swagger

第一步:创建一个SpringBoot项目

第二步:引入maven坐标

<parent>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-parentartifactId>
        <version>2.1.14.RELEASEversion>
        <relativePath/> 
    parent>
<dependencies>

        <dependency>
            <groupId>io.springfoxgroupId>
            <artifactId>springfox-swagger2artifactId>
            <version>2.7.0version>
        dependency>
        
        <dependency>
            <groupId>io.springfoxgroupId>
            <artifactId>springfox-swagger-uiartifactId>
            <version>2.7.0version>
        dependency>
    dependencies>
<

你可能感兴趣的:(Swagger,Swagger,SpringBoot,API调试)