mirror of
https://gitee.com/many2many/java-web.git
synced 2025-01-11 22:50:54 +08:00
100 lines
2.6 KiB
Markdown
100 lines
2.6 KiB
Markdown
|
## 1. 附件上传
|
|||
|
|
|
|||
|
|
### 1.1 接口描述
|
|||
|
|
上传图片、视频、压缩文件等。
|
|||
|
|
### 1.2 请求URL
|
|||
|
|
`/v1/post`
|
|||
|
|
|
|||
|
|
### 1.3 请求方式
|
|||
|
|
**POST**
|
|||
|
|
|
|||
|
|
multipart/form-data方式上传文件
|
|||
|
|
|
|||
|
|
### 1.4 请求头示例
|
|||
|
|
```http
|
|||
|
|
Content-Type: multipart/form-data; boundary=----12256474795412178794287418104
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 1.6 请求体示例
|
|||
|
|
```http
|
|||
|
|
-----------------------------12256474795412178794287418104
|
|||
|
|
Content-Disposition: form-data; name="type"
|
|||
|
|
|
|||
|
|
public/image
|
|||
|
|
-----------------------------12256474795412178794287418104
|
|||
|
|
Content-Disposition: form-data; name="file"; filename="2024-03-18_22-06.png"
|
|||
|
|
Content-Type: image/png
|
|||
|
|
这里是文件内容...
|
|||
|
|
-----------------------------12256474795412178794287418104
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
```http
|
|||
|
|
-----------------------------35576727471291609851653063070
|
|||
|
|
Content-Disposition: form-data; name="type"
|
|||
|
|
attachment
|
|||
|
|
-----------------------------35576727471291609851653063070
|
|||
|
|
Content-Disposition: form-data; name="file"; filename="paopao.zip"
|
|||
|
|
Content-Type: application/zip
|
|||
|
|
这里是文件内容...
|
|||
|
|
-----------------------------35576727471291609851653063070
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 1.7 返回参数说明
|
|||
|
|
| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述 |
|
|||
|
|
|------| ---- | -------- | -- |-----------|
|
|||
|
|
| code | 是 | 整型 | | 错误码，0表示成功 |
|
|||
|
|
| msg | 否 | 字符串 | | 错误信息描述 |
|
|||
|
|
| data | 否 | json | | 具体业务数据 |
|
|||
|
|
|
|||
|
|
|
|||
|
|
data结构说明：
|
|||
|
|
|
|||
|
|
| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述 |
|
|||
|
|
|-------| ---- | -------- |------|-----------|
|
|||
|
|
| | | | | |
|
|||
|
|
|
|||
|
|
### 1.8 响应示例（成功）
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 0,
|
|||
|
|
"msg": "success",
|
|||
|
|
"data": {
|
|||
|
|
"user_id": 100066,
|
|||
|
|
"file_size": 249763,
|
|||
|
|
"img_width": 0,
|
|||
|
|
"img_height": 0,
|
|||
|
|
"type": 1,
|
|||
|
|
"content": "http://60.204.241.255:8008/oss/paopao/public/image/4f/77/ec/5f/85ad-4189-887d-785cac178e21.png"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
### 1.9 响应示例（错误）
|
|||
|
|
```json
|
|||
|
|
{ "code": 500, "msg": "失败" }
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 1.10 错误响应码参考
|
|||
|
|
更多响应错误码及含义，请参阅[API响应码表](URL/for/api/responseCode/table)。
|
|||
|
|
|
|||
|
|
### 1.11 安全性与认证
|
|||
|
|
|
|||
|
|
|
|||
|
|
### 1.12 测试环境
|
|||
|
|
访问测试环境以进行接口调试：
|
|||
|
|
[https://test.apiAddress.com](https://test.apiAddress.com)
|
|||
|
|
|
|||
|
|
### 1.13 版本管理
|
|||
|
|
本API通过URI路径进行版本控制。请在请求URL中包含`/v1`以使用当前版本。
|
|||
|
|
|
|||
|
|
### 1.14 更新记录
|
|||
|
|
- **2024-04-29**：发布文档初始版本。
|
|||
|
|
|
|||
|
|
|
|||
|
|
### 1.15 联系支持
|
|||
|
|
如需帮助或对API有任何疑问，请通过电子邮件与我们联系：[support@api.com](mailto:support@api.com)。
|
|||
|
|
|
|||
|
|
### 1.16 反馈与建议
|
|||
|
|
发现文档问题或有改进建议？请填写[反馈表单](https://forms.api.com/feedback)与我们分享。
|
|||
|
|
|