RicoSuter/NSwag

OpenAPI 3.0.1 upload/download file example

Open

#2,495 opened on Oct 30, 2019

View on GitHub
 (25 comments) (13 reactions) (0 assignees)C# (1,189 forks)batch import
format: OpenAPI 3help wanted

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Do you have an example of what an ASP.Net Core 3.0 API operation that uploads and downloads a file and what the OpenAPI 3.0.1 yaml should look like in order to properly generate a client using NSwag code generator?

I've tried every combination I can think of, and nothing seems to work. Either I get errors trying to deserialize to a FileContent type, or I get errors about not finding the Content boundary or else the client has random parameters that aren't used or a myriad of other issues. At this point, my yaml is identical to what's on the OpenApi documentation page, but this doesn't work, either: https://swagger.io/docs/specification/describing-request-body/file-upload/ I just need a working example to go off of so I can stop guessing.

Contributor guide

Research direction
Look for existing file upload examples in NSwag repository or ASP.NET Core documentation. Create a minimal API endpoint that accepts and returns files, annotate with OpenAPI attributes, and generate the YAML. Provide the full controller code and corresponding OpenAPI spec.
Tech stack
csharp
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70