Crow/docs/guides/multipart.md

<span class="tag">[:octicons-feed-tag-16: v0.2](https://github.com/CrowCpp/Crow/releases/0.2)</span>


Multipart is a way of forming HTTP requests or responses to contain multiple distinct parts.<br>

Such an approach allows a request to contain multiple different pieces of data with potentially conflicting data types in a single response payload.<br>
It is typically used either in HTML forms, or when uploading multiple files.<br><br>

## How multipart messages work
The structure of a multipart request is typically consistent of:<br>

- A Header: Typically `multipart/form-data;boundary=<boundary>`, This defines the HTTP message as being multipart, as well as defining the separator used to distinguish the different parts.<br>
- 1 or more parts:
    - `--<boundary>`
    - Part header: typically `content-disposition: mime/type; name="<fieldname>"` (`mime/type` should be replaced with the actual mime-type), can also contain a `filename` property (separated from the rest by a `;` and structured similarly to the `name` property)
    - Value
- `--<boundary>--`<br><br>

## Multipart messages in Crow
Crow supports multipart requests and responses though `crow::multipart::message`.<br>
A message can be created either by defining the headers, boundary, and individual parts and using them to create the message. or simply by reading a `crow::request`.<br><br>

Once a multipart message has been made, the individual parts can be accessed throughout `msg.parts`, `parts` is an `std::vector`.<br><br>

<span class="tag">[:octicons-feed-tag-16: v1.0](https://github.com/CrowCpp/Crow/releases/v1.0)</span>


Part headers are organized in a similar way to request and response headers, and can be retrieved via `crow::multipart::get_header_object("header-key")`. This function returns a `crow::multipart::header` object.<br><br>

The message's individual body parts can be accessed by name using `msg.get_part_by_name("part-name")`.<br><br>

For more info on Multipart messages, go [here](../reference/namespacecrow_1_1multipart.html)
improved "introduced in" statements 2022-05-12 21:49:52 +00:00			`<span class="tag">[:octicons-feed-tag-16: v0.2](https://github.com/CrowCpp/Crow/releases/0.2)</span>`

updated documentation in mkdocs and doxygen 2022-03-23 22:55:46 +00:00
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00			`Multipart is a way of forming HTTP requests or responses to contain multiple distinct parts.<br>`
multiple docs changes: Added meta tags for homepage Added meta description generator Removed usages of <h1> (mkdocs-material doesn't reconize more than 1) added space after # (markdown proper syntax) removed pip3 command from pull request CI 2021-11-06 08:54:29 +00:00
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00			`Such an approach allows a request to contain multiple different pieces of data with potentially conflicting data types in a single response payload.<br>`
updated documentation in mkdocs and doxygen 2022-03-23 22:55:46 +00:00			`It is typically used either in HTML forms, or when uploading multiple files.<br><br>`
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00
updated documentation in mkdocs and doxygen 2022-03-23 22:55:46 +00:00			`## How multipart messages work`
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00			`The structure of a multipart request is typically consistent of:<br>`

			- A Header: Typically `multipart/form-data;boundary=<boundary>`, This defines the HTTP message as being multipart, as well as defining the separator used to distinguish the different parts.<br>
			`- 1 or more parts:`
			- `--<boundary>`
			- Part header: typically `content-disposition: mime/type; name="<fieldname>"` (`mime/type` should be replaced with the actual mime-type), can also contain a `filename` property (separated from the rest by a `;` and structured similarly to the `name` property)
			`- Value`
			- `--<boundary>--`<br><br>

updated documentation in mkdocs and doxygen 2022-03-23 22:55:46 +00:00			`## Multipart messages in Crow`
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00			Crow supports multipart requests and responses though `crow::multipart::message`.<br>
			A message can be created either by defining the headers, boundary, and individual parts and using them to create the message. or simply by reading a `crow::request`.<br><br>

updated documentation in mkdocs and doxygen 2022-03-23 22:55:46 +00:00			Once a multipart message has been made, the individual parts can be accessed throughout `msg.parts`, `parts` is an `std::vector`.<br><br>

improved "introduced in" statements 2022-05-12 21:49:52 +00:00			`<span class="tag">[:octicons-feed-tag-16: v1.0](https://github.com/CrowCpp/Crow/releases/v1.0)</span>`

updated documentation in mkdocs and doxygen 2022-03-23 22:55:46 +00:00
			Part headers are organized in a similar way to request and response headers, and can be retrieved via `crow::multipart::get_header_object("header-key")`. This function returns a `crow::multipart::header` object.<br><br>

			The message's individual body parts can be accessed by name using `msg.get_part_by_name("part-name")`.<br><br>
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00
adapted doxygen config and markdown links to in source build of documentation added cloning of doxygen theme 2023-06-08 14:56:34 +00:00			`For more info on Multipart messages, go [here](../reference/namespacecrow_1_1multipart.html)`