swagger基本使用及常用注解

一、介绍

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

 作用：

    1. 接口的文档在线自动生成。

    2. 功能测试。

每当我在学习一门知识的都会习惯性的去看他的介绍，了解出现的起源、使用的目的。

或许有人就会问了，知道是什么但是还是不太理解，那怎么办......

那就举个栗子：

试想有这样一个场景，你们的公司做的项目非常的庞大，大到什么规模呢。就好比你的项目组在北京开发，另一个项目组在加拿大，或者是个人在外国的某一个角落开发，那该怎么清楚快速的知道是你想要的接口呢。那么就有人就会说了（打个电话告诉他不就好了），那么如果与你们开发合作的是外国的合作小组呢，难道还要专门添一个精通各国语言的翻译嘛。并不是 、正所谓 有需求就有市场  于是swagger就诞生了。

 二、实战演练

1、首先准备一个springboot的项目

2、导入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>

3、创建一个配置类SwaggerConfig

注意：以下文档化的路径为你自己的包路径

/**
 * @Description
 * @ClassName SwaggerConfig
 * @Author Ninja
 * @date 2021.11.12 14:32
 */
@Configuration//声明这是一个配置类
@EnableSwagger2//开