写一个http接受文件的 api接口文档,需要接受fileName,type参数。
时间: 2024-11-05 17:29:25 浏览: 20
API接口文档示例:
标题:接收文件上传 - 文件上传服务 (FileUpload Service)
### 描述
这个API接口允许用户通过HTTP POST请求上传文件。(fileName)和(type)参数必不可少,用于指定文件名以及文件类型。
#### 接口 URL
```http
POST /api/upload-file
```
#### 请求头
- **Content-Type**: 应设置为 "multipart/form-data",表示发送的是表单数据,包括文件部分。
#### 请求体 (Multipart Form Data)
```json
{
"fileName": "文件名(不超过100字符)",
"type": "文件类型(如image/jpeg, text/plain等)",
"file": <base64编码的文件数据>
}
```
**注意:**
- `fileName` 字段应提供清晰描述的文件名,例如 "report.pdf"。
- `type` 字段需包含正确的文件 MIME 类型。
- `file` 字段包含了文件内容,通常是Base64编码后的字符串,对于大文件建议分块上传。
#### 示例请求
```shell
curl -X POST \
-H 'Content-Type: multipart/form-data' \
-F "fileName=document.jpg" \
-F "type=image/jpeg" \
-F "file=@path/to/local/file.jpg" \
http://your-api-server/api/upload-file
```
或者,如果使用POSTman客户端,可以使用类似下面的方式构造请求:
```json
{
"form": [
{
"key": "fileName",
"value": "document.jpg",
"type": "text"
},
{
"key": "type",
"value": "image/jpeg",
"type": "text"
},
{
"key": "file",
"filename": "local_file.jpg",
"data": "<base64-encoded-file-content>"
}
]
}
```
阅读全文
相关推荐
![pdf](https://img-home.csdnimg.cn/images/20241231044930.png)
![docx](https://img-home.csdnimg.cn/images/20241231044901.png)
![pdf](https://img-home.csdnimg.cn/images/20241231044930.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)