Swagger 文档

pom.xml

@@ -116,6 +116,19 @@
 			<version>2.0.4</version>
 		</dependency>
 
+		<!-- swagger2 -->
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger2</artifactId>
+			<version>2.7.0</version>
+		</dependency>
+
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger-ui</artifactId>
+			<version>2.7.0</version>
+		</dependency>
+
 	</dependencies>
 
 	<profiles>

src/main/java/com/huiju/estateagents/config/Swagger2Config.java

@@ -0,0 +1,37 @@
+package com.huiju.estateagents.config;
+
+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.service.ApiInfo;
+import springfox.documentation.service.Contact;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+@Configuration
+@EnableSwagger2
+public class Swagger2Config {
+
+
+    @Bean
+    public Docket docket(){
+        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
+                .apis(RequestHandlerSelectors.basePackage("com.huiju.estateagents.controller"))
+                .paths(PathSelectors.any()).build();
+    }
+    //构建api文档的详细信息函数
+    private ApiInfo apiInfo(){
+        return new ApiInfoBuilder()
+                //页面标题
+                .title("营销云 的 RESTful API")
+                //版本号
+                .version("1.0")
+                //描述
+                .description("API 描述")
+                .build();
+    }
+
+}

src/main/java/com/huiju/estateagents/controller/TdBuildingTypeController.java

@@ -6,6 +6,8 @@ import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
 import com.huiju.estateagents.base.ResponseBean;
 import com.huiju.estateagents.entity.TdBuildingType;
 import com.huiju.estateagents.service.ITdBuildingTypeService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -30,6 +32,7 @@ import javax.servlet.http.HttpServletRequest;
  */
 @RestController
 @RequestMapping("/api")
+@Api(value = "项目类型", tags = "项目类型")
 public class TdBuildingTypeController extends BaseController {
 
     private final Logger logger = LoggerFactory.getLogger(TdBuildingTypeController.class);
@@ -44,6 +47,7 @@ public class TdBuildingTypeController extends BaseController {
      * @param pageSize
      * @return
      */
+    @ApiOperation(value = "查询项目类型", notes = "查询项目类型")
     @RequestMapping(value="/admin/tdBuildingType",method= RequestMethod.GET)
     public ResponseBean tdBuildingTypeList(@RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
                                            @RequestParam(value ="pageSize",defaultValue = "10") Integer pageSize,

src/main/java/com/huiju/estateagents/interceptor/AccessInterceptor.java

@@ -53,6 +53,14 @@ public class AccessInterceptor implements HandlerInterceptor {
             "/api/wx/qrcode/scene",
 		    "/api/center/signin",
 		    "/api/admin/taUser/signin",
+            "/swagger-resources/configuration/ui",
+            "/swagger-resources",
+            "/v2/api-docs",
+            "/swagger-resources/configuration",
+            "/swagger-ui.html",
+            "/webjars",
+            "/webjars/springfox-swagger-ui",
+            "/webjars/springfox-swagger-ui/css/typography.css"
     };
 
     /*
@@ -125,17 +133,17 @@ public class AccessInterceptor implements HandlerInterceptor {
             response.getOutputStream().write(JSONObject.toJSONBytes(resp));
             return false;
         }
-        
+
         //添加如果执行了登出操作提示先进行登录
         SysToken sysToken = sysTokenService.getById(jwtAuths[1]);
         if (null == sysToken){
             ResponseBean resp = ResponseBean.error("请先进行系统登录操作", ResponseBean.ERROR_AUTH_FAIL);
-    
+
             response.addHeader("Content-type", "application/json");
             response.getOutputStream().write(JSONObject.toJSONBytes(resp));
             return false;
         }
-        
+
 //        按钮权限校验
         boolean state = checkButtonRole(request);
         if (!state){