Docs: add multipart/form-data guidance (link/usage example for aide-axum-typed-multipart) #284
Description
Problem
Multipart/form-data (file uploads, mixed fields) is a common API shape in axum apps, but aide’s main docs/examples don’t make it obvious what the recommended approach is.
There is an external integration crate (aide-axum-typed-multipart) mentioned in #267, but it is easy to miss if you start from docs.rs / README.
Proposed documentation improvements
- Add a short section in the axum docs (docs.rs) and/or README:
- “For typed multipart/form-data, use
aide-axum-typed-multipart” - minimal snippet showing how to model a form with a file field
- feature flags / version compatibility notes
- “For typed multipart/form-data, use
- (Optional) add a small example under
examples/demonstrating multipart.
Related
- Announcement: axum-jsonschema and aide-axum-typed-multipart have been updated and published, aide 0.15 compatible #267 announces the crate update and compatibility, but this issue is about making multipart discoverable and providing a canonical example in aide’s docs.
Why this matters
Without explicit guidance, users often assume multipart is unsupported or end up hand-writing requestBody schemas inconsistently.