Skip to content
This repository was archived by the owner on Mar 6, 2024. It is now read-only.

Commit 7ac740d

Browse files
easepaneasepan
committed
test swagger
1 parent b3d14a0 commit 7ac740d

File tree

6 files changed

+61
-4
lines changed

6 files changed

+61
-4
lines changed

‎README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@
88

99
> 第一次运行系统，请先运行 [SQL代码](/mysql/efo.sql) , 并登陆系统修改用户 `system` （默认密码 `123456`）的密码
1010
11+
### 环境要求
12+
13+
- MySQL 5.7+
14+
15+
- JDK 1.8+
16+
1117
### 系统部分截图（背景图片可通过配置设置）
1218

1319
- 登录页面（包含登录、注册、密码重置），路径 `/signin`
@@ -36,4 +42,4 @@
3642

3743
> [angular-filamanager](https://github.com/joni2back/angular-filemanager)
3844

39-
**最后，如果大家有什么好的建议欢迎提出哦，觉得可以的话，给个star呗**
45+
**项目有不足的地方欢迎提出来哦，大家一起交流学习，觉得不错的话，Star来一个呗**

‎efo.iml

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@
110110
<orderEntry type="library" name="Maven: org.slf4j:slf4j-api:1.7.25" level="project" />
111111
<orderEntry type="library" scope="TEST" name="Maven: org.assertj:assertj-core:3.8.0" level="project" />
112112
<orderEntry type="library" scope="TEST" name="Maven: org.mockito:mockito-core:2.12.0" level="project" />
113-
<orderEntry type="library" scope="TEST" name="Maven: net.bytebuddy:byte-buddy:1.7.9" level="project" />
113+
<orderEntry type="library" name="Maven: net.bytebuddy:byte-buddy:1.7.9" level="project" />
114114
<orderEntry type="library" scope="TEST" name="Maven: net.bytebuddy:byte-buddy-agent:1.7.9" level="project" />
115115
<orderEntry type="library" scope="TEST" name="Maven: org.objenesis:objenesis:2.6" level="project" />
116116
<orderEntry type="library" name="Maven: org.hamcrest:hamcrest-core:1.3" level="project" />
@@ -121,5 +121,20 @@
121121
<orderEntry type="library" name="Maven: org.springframework:spring-jcl:5.0.2.RELEASE" level="project" />
122122
<orderEntry type="library" scope="TEST" name="Maven: org.springframework:spring-test:5.0.2.RELEASE" level="project" />
123123
<orderEntry type="library" scope="TEST" name="Maven: org.xmlunit:xmlunit-core:2.5.1" level="project" />
124+
<orderEntry type="library" name="Maven: com.spring4all:swagger-spring-boot-starter:1.7.1.RELEASE" level="project" />
125+
<orderEntry type="library" name="Maven: io.springfox:springfox-swagger-ui:2.9.0" level="project" />
126+
<orderEntry type="library" name="Maven: io.springfox:springfox-spring-web:2.9.0" level="project" />
127+
<orderEntry type="library" name="Maven: io.springfox:springfox-swagger2:2.9.0" level="project" />
128+
<orderEntry type="library" name="Maven: io.swagger:swagger-annotations:1.5.18" level="project" />
129+
<orderEntry type="library" name="Maven: io.swagger:swagger-models:1.5.18" level="project" />
130+
<orderEntry type="library" name="Maven: io.springfox:springfox-spi:2.9.0" level="project" />
131+
<orderEntry type="library" name="Maven: io.springfox:springfox-core:2.9.0" level="project" />
132+
<orderEntry type="library" name="Maven: io.springfox:springfox-schema:2.9.0" level="project" />
133+
<orderEntry type="library" name="Maven: io.springfox:springfox-swagger-common:2.9.0" level="project" />
134+
<orderEntry type="library" name="Maven: com.google.guava:guava:20.0" level="project" />
135+
<orderEntry type="library" name="Maven: org.springframework.plugin:spring-plugin-core:1.2.0.RELEASE" level="project" />
136+
<orderEntry type="library" name="Maven: org.springframework.plugin:spring-plugin-metadata:1.2.0.RELEASE" level="project" />
137+
<orderEntry type="library" name="Maven: org.mapstruct:mapstruct:1.2.0.Final" level="project" />
138+
<orderEntry type="library" name="Maven: io.springfox:springfox-bean-validators:2.9.0" level="project" />
124139
</component>
125140
</module>

‎pom.xml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,11 @@
7777
</exclusion>
7878
</exclusions>
7979
</dependency>
80+
<dependency>
81+
<groupId>com.spring4all</groupId>
82+
<artifactId>swagger-spring-boot-starter</artifactId>
83+
<version>1.7.1.RELEASE</version>
84+
</dependency>
8085
</dependencies>
8186

8287
<build>

‎src/main/java/com/zhazhapan/efo/EfoApplication.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package com.zhazhapan.efo;
22

3+
import com.spring4all.swagger.EnableSwagger2Doc;
34
import com.zhazhapan.config.JsonParser;
45
import com.zhazhapan.efo.config.TokenConfig;
56
import com.zhazhapan.efo.modules.constant.ConfigConsts;
@@ -21,6 +22,7 @@
2122
* @author pantao
2223
*/
2324
@SpringBootApplication
25+
@EnableSwagger2Doc
2426
@MapperScan("com.zhazhapan.efo.dao")
2527
@EnableAutoConfiguration
2628
@EnableTransactionManagement

‎src/main/java/com/zhazhapan/efo/web/controller/FileMangerController.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,19 @@
1010
import org.springframework.lang.Nullable;
1111
import org.springframework.web.bind.annotation.*;
1212
import org.springframework.web.multipart.MultipartFile;
13+
import springfox.documentation.annotations.ApiIgnore;
1314

1415
import javax.servlet.http.HttpServletResponse;
1516
import java.io.IOException;
1617

1718
/**
19+
* filemanager api
20+
* <a href="https://github.com/joni2back/angular-filemanager/blob/master/API.md">see api doc</a>
21+
*
1822
* @author pantao
1923
* @since 2018/1/29
2024
*/
25+
@ApiIgnore
2126
@RestController
2227
@RequestMapping("/filemanager")
2328
@AuthInterceptor(InterceptorLevel.SYSTEM)
@@ -42,7 +47,7 @@ public void multiDownload(HttpServletResponse response, String[] items, String t
4247

4348
@AuthInterceptor(InterceptorLevel.SYSTEM)
4449
@RequestMapping(value = "/download", method = RequestMethod.GET)
45-
public void upload(HttpServletResponse response, String path) throws IOException {
50+
public void download(HttpServletResponse response, String path) throws IOException {
4651
ControllerUtils.loadResource(response, path, ValueConsts.TRUE);
4752
}
4853

‎src/main/resources/application.properties

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,28 @@ spring.servlet.multipart.max-request-size=1099511627776
1010
spring.devtools.restart.enabled=false
1111
spring.devtools.restart.additional-paths=src/main
1212
#spring.profiles.active=prod
13-
#spring.mvc.favicon.enabled=false
13+
#spring.mvc.favicon.enabled=false
14+
swagger.enabled=true
15+
16+
swagger.title=线上文件管理系统
17+
swagger.description=上传、下载、分享、远程文件管理
18+
swagger.version=1.2
19+
swagger.license=MIT
20+
swagger.licenseUrl=https://opensource.org/licenses/MIT
21+
swagger.termsOfServiceUrl=https://github.com/code4everything/efo
22+
swagger.contact.name=zhazhapan
23+
swagger.contact.url=https://github.zhazhapan.com
24+
swagger.contact.email=zhazhapan.com
25+
swagger.base-package=com.zhazhapan.efo
26+
swagger.base-path=/**
27+
swagger.exclude-path=/error, /ops/**
28+
29+
swagger.apply-default-response-messages=false
30+
swagger.global-response-message.get[0].code=401
31+
swagger.global-response-message.get[0].message=401get
32+
swagger.global-response-message.get[1].code=500
33+
swagger.global-response-message.get[1].message=500get
34+
swagger.global-response-message.get[1].modelRef=ERROR
35+
swagger.global-response-message.post[0].code=500
36+
swagger.global-response-message.post[0].message=500post
37+
swagger.global-response-message.post[0].modelRef=ERROR

0 commit comments

Comments
 (0)