Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added support for multipart/form-data and x-www-form-urlencoded #9

Merged
merged 2 commits into from
Apr 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 125 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,131 @@ Below are the optional parameters that can be specified for the formatter to cus
└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
```

### POST request [multipart/form-data]
```dart
await dio.post(
"https://postman-echo.com/post",
data: FormData.fromMap({
"foo": "foo",
"bar": MultipartFile.fromBytes([1, 2, 3, 4, 5, 6])
}),
);
```
```text
┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
│ ⤴ REQUEST ⤴
│ POST https://postman-echo.com/post
│ content-type: multipart/form-data; boundary=--dio-boundary-0846883596
│ content-length: 234
│ {
│ "foo": "foo",
│ "bar": "[application/octet-stream; length=6]"
│ }
│ ⤵ RESPONSE [200/OK] [Time elapsed: 1431 ms]⤵
│ etag: [W/"238-Drbr+mbesAC7mnUT1/6HdwqJbOg"]
│ connection: [keep-alive]
│ content-type: [application/json; charset=utf-8]
│ set-cookie: [sails.sid=s%3AYZPFhMKwqVTkLbZkRSbdqY_ZGZYFul8h.UrGXXLdzjfYJEdEVOlpQND2Ms3KnpKomTNQh42u3tS4; Path=/; HttpOnly]
│ date: [Sun, 19 Mar 2023 12:39:21 GMT]
│ content-length: [568]
│ {
│ "args": {},
│ "data": {},
│ "files": {
│ "undefined": "data:application/octet-stream;base64,AQIDBAUG"
│ },
│ "form": {
│ "foo": "foo"
│ },
│ "headers": {
│ "x-forwarded-proto": "https",
│ "x-forwarded-port": "443",
│ "host": "postman-echo.com",
│ "x-amzn-trace-id": "Root=1-64170279-48f590a477b666d63975dd13",
│ "content-length": "234",
│ "user-agent": "Dart/2.19 (dart:io)",
│ "content-type": "multipart/form-data; boundary=--dio-boundary-0846883596",
│ "accept-encoding": "gzip"
│ },
│ "json": null,
│ "url": "https://postman-echo.com/post"
│ }
└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
```

### POST request [application/x-www-form-urlencoded]
```dart
await dio.post(
"https://postman-echo.com/post",
data: {
"foo": "foo",
"bar": "bar",
},
options: Options(
contentType: Headers.formUrlEncodedContentType,
),
);
```
```text
┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
│ ⤴ REQUEST ⤴
│ POST https://postman-echo.com/post
│ content-type: application/x-www-form-urlencoded
│ content-length: 15
│ {
│ "foo": "foo",
│ "bar": "bar"
│ }
│ ⤵ RESPONSE [200/OK] [Time elapsed: 1419 ms]⤵
│ etag: [W/"213-RckysDJgyaHU3rsP8vCoDnqI4Pg"]
│ connection: [keep-alive]
│ content-type: [application/json; charset=utf-8]
│ set-cookie: [sails.sid=s%3AxDq5jvVLfuAkxh5o0pUhZOLzkqPt4xBz.apV3a%2FKrhiKWA%2B7foUqihO0BMGTnCOwVSiiW93CBozo; Path=/; HttpOnly]
│ date: [Sun, 19 Mar 2023 12:42:13 GMT]
│ content-length: [531]
│ {
│ "args": {},
│ "data": "",
│ "files": {},
│ "form": {
│ "foo": "foo",
│ "bar": "bar"
│ },
│ "headers": {
│ "x-forwarded-proto": "https",
│ "x-forwarded-port": "443",
│ "host": "postman-echo.com",
│ "x-amzn-trace-id": "Root=1-64170325-433157c952cf5ed84f36f867",
│ "content-length": "15",
│ "user-agent": "Dart/2.19 (dart:io)",
│ "content-type": "application/x-www-form-urlencoded",
│ "accept-encoding": "gzip"
│ },
│ "json": {
│ "foo": "foo",
│ "bar": "bar"
│ },
│ "url": "https://postman-echo.com/post"
│ }
└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
```



### Successful GET request [text/html]

```dart
Expand Down
23 changes: 21 additions & 2 deletions lib/src/dio_http_formatter_base.dart
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,9 @@ class HttpFormatter extends Interceptor {

/// Whether to pretty print a JSON or return as regular String
String _getBody(dynamic data, String? contentType) {
if (contentType != null &&
contentType.toLowerCase().contains('application/json')) {
final type = contentType?.toLowerCase();
if (type?.contains('application/json') == true ||
type?.contains('application/x-www-form-urlencoded') == true) {
final encoder = JsonEncoder.withIndent(' ');
// Since the JSON could be a Map or List
dynamic jsonBody;
Expand All @@ -90,6 +91,8 @@ class HttpFormatter extends Interceptor {
jsonBody = data;
}
return encoder.convert(jsonDecode(jsonEncode(jsonBody)));
} else if (type?.contains("multipart/form-data") == true) {
return JsonEncoder.withIndent(' ').convert(formDataToJson(data));
} else {
return data.toString();
}
Expand Down Expand Up @@ -160,4 +163,20 @@ class HttpFormatter extends Interceptor {

return requestString + responseString;
}

Map<String, dynamic> formDataToJson(FormData formData) {
final map = <String, dynamic>{};
for (final entry in formData.fields) {
map[entry.key] = entry.value;
}
for (final file in formData.files) {
var responseString = "[application/octet-stream; ";
if (file.value.filename != null) {
responseString += "filename=${file.value.filename}; ";
}
responseString += "length=${file.value.length}]";
map[file.key] = responseString;
}
return map;
}
}