构造Form表单(设计接口)时,Enctype属性到底该如何选择?

开发 前端
最近在写个小工具,功能是把本地的Swagger格式的接口文档一键上传到接口管理平台Yapi和Metersphere上,在看两个平台的导入接口文档Openapi后发现都不是很规范。

问题由来

定义上传文件接口时,都会选择使用 multipart/form-data 方式,即要求表单的enctype属性为multipart/form-data,文件以file类型提交,参数以key-value方式提交。最近在写个小工具,功能是把本地的swagger格式的接口文档一键上传到接口管理平台yapi和metersphere上,在看两个平台的导入接口文档openapi后发现都不是很规范。

先看下ypai导入接口文档接口的设计,yapi要求使用application/x-www-form-urlencoded 方式导入文件(将文件内容作为一个key的value,本质上不是上传文件,文件比较大的时候这种方式性能很低)

再看下metersphere导入接口文档接口的设计,因为官方文档写的不够详细,文档中没有体现传参方式,所以通过抓包看。抓包后参数部分如下:

------WebKitFormBoundary2iHGla7AYYuM2hRW
Content-Disposition: form-data; name="file"; filename="swagger.json"
Content-Type: application/json
------WebKitFormBoundary2iHGla7AYYuM2hRW
Content-Disposition: form-data; name="request"; filename="blob"
Content-Type: application/json

{"file":{"uid":1678539466009},"modeId":"incrementalMerge","moduleId":"64a43afa-a846-431b-9b5a-72c0d40081ab","coverModule":false,"modulePath":"/未规划接口","platform":"Swagger2","saved":true,"model":"definition","projectId":"6783a271-f88f-569d-b6a5-43ef180bd17a","protocol":"HTTP"}
------WebKitFormBoundary2iHGla7AYYuM2hRW--

可以看出是使用了multipart/form-data方式,需要导入的文件也是以file类型提交的,但是参数部分竟然也要求使用file类型提交。

enctype属性

enctype规定了form表单发送到服务器的编码方式,有如下的三个值:

  • application/x-www-form-urlencoded:在发送前编码所有字符,把表单数据转换成一个字串(key1=value1&key2=value2…),当请求方式为get时拼接到url后面并使用用?分割(例如http://test.com/xxx/detail?key1=value1&key2=value2);当请求方式为post时放到到body中。
  • multipart/form-data:不对字符编码,如果表单中既有文本数据,又有文件等二进制数据,必须使用此值。浏览器(自己构造表单也需要这么做)会把整个表单以控件为单位分割,并为每个部分加上Content-Disposition、分割符(boundary),另外文件类型的会加上Content-Type(默认为application/octet-stream)。
  • text/plain:将空格转换为"+"号,但不对特殊字符编码,不建议使用。

小结

如果接口没有上传文件的需求,使用application/x-www-form-urlencoded 即可。

如果接口有上传文件的需求,使用 multipart/form-data,文件以file类型提交,参数以key-value方式提交。

责任编辑:姜华 来源: 今日头条
相关推荐

2020-07-14 14:40:05

激光喷墨打印

2020-06-02 14:40:42

5G边缘计算物联网

2011-07-18 09:48:10

jQuery

2021-01-15 19:10:32

日志打印原则

2022-05-16 10:59:46

GPIOLinux内核

2021-08-04 07:47:17

表单组件代码

2022-04-05 22:18:40

面板低代码平台

2021-11-04 18:15:55

下载上传浏览器

2009-07-29 16:40:50

Ajax提交asp.n

2017-11-14 06:10:15

机器学习编程语言数据科学

2011-12-11 11:51:28

2024-09-19 08:46:46

SPIAPI接口

2013-09-04 15:17:38

2011-12-28 15:24:21

2015-07-09 10:22:27

CloudStackOpenStack云计算

2021-07-08 21:51:03

5G技术Wi-Fi 6

2022-06-14 21:14:18

5.5GAI数字化

2014-02-14 14:36:00

2022-02-23 21:08:53

数字4G5G

2023-10-20 13:30:36

代码接口
点赞
收藏

51CTO技术栈公众号