Swagger的配置及使用教程

系列文章目录

@Swagger的配置及使用教程

---

一、使用

1.新建一个springboot项目。

File ----- new------ project 出现如下图,然后next

看到下图，选择Spring Web,然后next

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>
  </dependencies>

3.写一个配置类

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

}

4.到这就可以了，启动一下看看是否成功，如果报错如下

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2022-04-21 11:33:57.867 ERROR 40104 --- [           main] o.s.boot.SpringApplication               : Application run failed

org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException

到pom.xml中，找到如下图代码。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.6.6</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>
  改成
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.5.6</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>

5.然后启动一下就会成功，本人亲测。祝各位看官事业有成，留个赞呗。

在浏览器输入网址：http://localhost:8080/swagger-ui.html，出现如下图就成功了