File 接口支持 Swagger

[QubitPi]

为什么要用 Swagger?

如今的前后端开发采用隔离架构，后端通常会把资源通过 API 的方式提供给前端访问和使用。在这样一个沟通无比重要的团队合作时代，
后端在开放 API 的时候面临这些问题和挑战：

1. 传统低效的口述根本无法满足软件的快速迭代要求
2. 需要一个统一的 API 标准来对其前后端的交互，同时，这个标准应该全面、易懂、和易用
3. 最重要的是，任何 API 的调整和变化都应该立马体出来，让前端知晓，人工维护这个 API 显然是不可能的，所以我们需要一个自动化技术来做这件事

Swagger 是传统 JSON API 的自动化文档的行业老大。不仅很好地解决了上面的问题，而且在国内外都是家喻户晓的后端技术，学习 swagger 对 @A-Little-Excited 的职业发展至关重要

本次工作目标

给文件上传和下载接口添加 Swagger 自动文档，方便前端调用

实现方法

Caution

请确保 spring 的版本是 3.x

在 athena-spring/athena-spring-boot-autoconfigure/pom.xml 里面加入如下依赖

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.2.0</version>
</dependency>

这样就完成了

提交 PR，在 Minerval 中引入最新的 athena 版本，启动 Minerval，访问 http://localhost:8080/swagger-ui/index.html 应该就可以看到我们的 Swagger API 文档了

Tip

更多相关文档请参阅 springdoc-openapi