Browse Source

添加swagger

cuijianhao 2 năm trước cách đây
mục cha
commit
1412f8aa80
2 tập tin đã thay đổi với 51 bổ sung2 xóa
  1. 16 2
      pom.xml
  2. 35 0
      src/main/java/sloths/demo/config/SwaggerConfig.java

+ 16 - 2
pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>3.0.6</version>
+        <version>2.7.8</version>
         <relativePath/> <!-- lookup parent from repository -->
     </parent>
     <groupId>sloths</groupId>
@@ -14,9 +14,23 @@
     <name>demo</name>
     <description>Demo project for Spring Boot</description>
     <properties>
-        <java.version>17</java.version>
+        <java.version>8</java.version>
     </properties>
     <dependencies>
+
+        <!--   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>
+
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-jdbc</artifactId>

+ 35 - 0
src/main/java/sloths/demo/config/SwaggerConfig.java

@@ -0,0 +1,35 @@
+package sloths.demo.config;
+
+import org.springframework.context.annotation.Configuration;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+
+@Configuration
+@EnableSwagger2
+public class SwaggerConfig {
+
+    public Docket createRestApi(){
+        return new Docket(DocumentationType.SWAGGER_2)
+                .apiInfo(apiInfo()) // 用于生成API信息
+                .select() // select()函数返回一个ApiSelectorBuilder实例,用来控制接口被swagger做成文档
+                .apis(RequestHandlerSelectors.basePackage("sloths.demo.controller")) //指定扫那个包
+                .paths(PathSelectors.any())
+                .build();
+    }
+
+    //定义主界面api信息
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder()
+                .title("外卖小程序sloths")
+                .description("外卖小程序sloths-SwaggerAPI管理")
+                .termsOfServiceUrl("")
+                .version("1.0")
+                .build();
+    }
+}