Swagger3的使用

本篇涉及到的swagger注解（速记）

@EnableSwagger2 开启swagger
@EnableOpenApi 开启swagger的Api功能
@EnableWebMvc 是为了解决swagger和springmvc整合之后总是出现空指针异常的问题,要有springBoot web依赖哦

Swagger

根据当前的服务端接口，自动的生成接口文档，这个所谓的接口文档，实际上就是一个网站。

• 数据接口
• 网页 UI

一项目搭建

创建一个SpringBoot项目，加入依赖

		<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
         <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

二.配置启动类

package com.huang.springboot9;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
/*开启swagger*/
@EnableSwagger2
@EnableOpenApi
/*EnableMVC，是为了解决swagger和springmvc整合之后总是出现空指针异常的问题,要有springBoot web依赖哦*/
@EnableWebMvc
public class SpringBoot9Application {
    public static void main(String[] args) {
        SpringApplication.run(SpringBoot9Application.class, args);
    }
}

三.写一个简单的controller

package com.huang.springboot9.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "hello";
    }
}

四.登录swagger网站;http://localhost:8080/swagger-ui/index.html

注意：

1.swagger2和swagger3的网站以及使用方法是不同的
2.你配置好注解后，运行springBoot后swagger的注解会自动为你配置好swagger