質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.50%
Swagger

Swaggerは、REST APIを定義するための標準仕様に基づいて構築された一連のオープンソースツール。REST APIの設計や構築、文書化、使用に便利なツールを提供。Swagger Specを書くことでドキュメント生成まで自動的に行い、さらにドキュメントから実際のリクエストを投げられます。

Q&A

解決済

1回答

4600閲覧

OpenAPI 3.0でCSVファイルをアップロードするAPIを定義する方法を教えてください

sassan738

総合スコア32

Swagger

Swaggerは、REST APIを定義するための標準仕様に基づいて構築された一連のオープンソースツール。REST APIの設計や構築、文書化、使用に便利なツールを提供。Swagger Specを書くことでドキュメント生成まで自動的に行い、さらにドキュメントから実際のリクエストを投げられます。

0グッド

0クリップ

投稿2021/10/25 10:30

現在担当しているタスクで、OpenAPI 3.0を使用してAPIの定義をしているのですが、CSVファイルをアップロードするAPI定義の方法が分かりません。公式ドキュメントを参照するとimage/pngの画像ファイルをアップロードするAPIの定義方法が書かれているのですが、CSV等のテキストファイルをアップロードする方法について書かれておらず、調べても情報が出てこないので困っています。
また、バックエンドへリクエストを送信するためのコードはnpmの@openapitools/openapi-generator-cliというパッケージを使用して自動生成しているのですが、リクエストが送信される時に、アップロードするファイルがどういう形式にエンコードされるのかということが分からず、現状は以下のコードのように定義しているのですが、これで大丈夫かどうかが分かりません。
どなたかご教授いただけると幸いです。よろしくお願い致します。

/import-csv: post: tags: - csv requestBody: required: true content: multipart/form-data: schema: type: object properties: file: type: string format: binary responses: "201": description: Created content: application/json: schema: $ref: "./schemas/importCsvResponse.yaml" "400": description: Bad Request "401": description: Unauthorized "500": description: Internal Server Error

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答1

0

自己解決

CSVファイルはバイナリーデータでは無いので以下のように記載しました。

requestBody: required: true content: text/csv: schema: type: string

投稿2021/10/26 02:42

sassan738

総合スコア32

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.50%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問