🎉 upload springboot-swagger3-demo

springboot-jpa-demo/src/main/java/com/cunyu/springbootjpademo/controller/UserController.java

@@ -59,6 +59,11 @@ public class UserController {
         userRepository.save(user);
     }
 
+    /**
+     * 查询所有用户
+     *
+     * @return
+     */
     @PostMapping("/query")
     public List<User> queryUsers() {
         List<User> userList = userRepository.findAll();

springboot-swagger3-demo/pom.xml

+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.5.6</version>
+        <relativePath/> <!-- lookup parent from repository -->
+    </parent>
+    <groupId>com.cunyu</groupId>
+    <artifactId>springboot-swagger3-demo</artifactId>
+    <version>0.0.1-SNAPSHOT</version>
+    <name>springboot-swagger3-demo</name>
+    <description>springboot-swagger3-demo</description>
+    <properties>
+        <java.version>1.8</java.version>
+    </properties>
+    <dependencies>
+        <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>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-devtools</artifactId>
+            <scope>runtime</scope>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-configuration-processor</artifactId>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <configuration>
+                    <excludes>
+                        <exclude>
+                            <groupId>org.projectlombok</groupId>
+                            <artifactId>lombok</artifactId>
+                        </exclude>
+                    </excludes>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

springboot-swagger3-demo/src/main/java/com/cunyu/springbootswagger3demo/SpringbootSwagger3DemoApplication.java

+package com.cunyu.springbootswagger3demo;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import springfox.documentation.oas.annotations.EnableOpenApi;
+
+@EnableOpenApi
+@SpringBootApplication
+public class SpringbootSwagger3DemoApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(SpringbootSwagger3DemoApplication.class, args);
+    }
+
+}

springboot-swagger3-demo/src/main/java/com/cunyu/springbootswagger3demo/config/SwaggerConfig.java

+package com.cunyu.springbootswagger3demo.config;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.oas.annotations.EnableOpenApi;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.service.Contact;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+
+import java.util.ArrayList;
+
+/**
+ * Created with IntelliJ IDEA.
+ *
+ * @author : 村雨遥
+ * @version : 1.0
+ * @project : springboot-swagger3-demo
+ * @package : com.cunyu.springbootswagger3demo.config
+ * @className : SwaggerConfig
+ * @createTime : 2022/1/6 14:19
+ * @email : 747731461@qq.com
+ * @微信 : cunyu1024
+ * @公众号 : 村雨遥
+ * @网站 : https://cunyu1943.github.io
+ * @description :
+ */
+
+@Configuration
+@EnableOpenApi
+public class SwaggerConfig {
+    /**
+     * 用于读取配置文件 application.properties 中 swagger 属性是否开启
+     */
+    @Value("${swagger.enabled}")
+    Boolean swaggerEnabled;
+
+    @Bean
+    public Docket docket() {
+        return new Docket(DocumentationType.OAS_30)
+                .apiInfo(apiInfo())
+                // 是否开启swagger
+                .enable(swaggerEnabled)
+                .select()
+                // 过滤条件，扫描指定路径下的文件
+                .apis(RequestHandlerSelectors.basePackage("com.cunyu.springbootswagger3demo.controller"))
+                // 指定路径处理，PathSelectors.any()代表不过滤任何路径
+                //.paths(PathSelectors.any())
+                .build();
+    }
+
+    private ApiInfo apiInfo() {
+        /*作者信息*/
+        Contact contact = new Contact("村雨遥", "https://cunyu1943.github.io", "747731461@qq.com");
+        return new ApiInfo(
+                "Spring Boot 集成 Swagger3 测试",
+                "Spring Boot 集成 Swagger3 测试接口文档",
+                "v1.0",
+                "https://cunyu1943.github.io",
+                contact,
+                "Apache 2.0",
+                "http://www.apache.org/licenses/LICENSE-2.0",
+                new ArrayList()
+        );
+    }
+}
+

springboot-swagger3-demo/src/main/java/com/cunyu/springbootswagger3demo/controller/UserController.java

+package com.cunyu.springbootswagger3demo.controller;
+
+import com.cunyu.springbootswagger3demo.entity.User;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Created with IntelliJ IDEA.
+ *
+ * @author : 村雨遥
+ * @version : 1.0
+ * @project : springboot-swagger3-demo
+ * @package : com.cunyu.springbootswagger3demo.controller
+ * @className : UserController
+ * @createTime : 2022/1/6 11:02
+ * @email : 747731461@qq.com
+ * @微信 : cunyu1024
+ * @公众号 : 村雨遥
+ * @网站 : https://cunyu1943.github.io
+ * @description :
+ */
+
+@Api(tags = "测试")
+@RestController
+@RequestMapping("/user")
+public class UserController {
+
+    @ApiOperation("测试接口")
+    @PostMapping("/show")
+    public String show(@RequestBody User user) {
+        return "hello," + user.getName() + ",welcome to springboot swagger3！";
+    }
+}

springboot-swagger3-demo/src/main/java/com/cunyu/springbootswagger3demo/entity/User.java

+package com.cunyu.springbootswagger3demo.entity;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * Created with IntelliJ IDEA.
+ *
+ * @author : 村雨遥
+ * @version : 1.0
+ * @project : springboot-swagger3-demo
+ * @package : com.cunyu.springbootswagger3demo.entity
+ * @className : User
+ * @createTime : 2022/1/6 11:17
+ * @email : 747731461@qq.com
+ * @微信 : cunyu1024
+ * @公众号 : 村雨遥
+ * @网站 : https://cunyu1943.github.io
+ * @description :
+ */
+
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+@ApiModel("用户实体类")
+public class User {
+    @ApiModelProperty(value = "姓名", required = true, example = "村雨遥")
+    private String name;
+}

springboot-swagger3-demo/src/main/resources/application.yml

+server:
+  port: 8080
+
+swagger:
+  enabled: true
+
+spring:
+  application:
+    name: springbooot-swagger3-demo

springboot-swagger3-demo/src/test/java/com/cunyu/springbootswagger3demo/SpringbootSwagger3DemoApplicationTests.java

+package com.cunyu.springbootswagger3demo;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+class SpringbootSwagger3DemoApplicationTests {
+
+    @Test
+    void contextLoads() {
+    }
+
+}