Document form data and images

オープン
  • 何か問題がありますか？
#874 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@hugosmoreira がすでに取り組んでいます。

2026年10月15日 から。

  • #1087 @hugosmoreira による — オープン

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
api

調査の方向性

まず、リクエストボディの生成経路と multipart/form-data の処理を特定し、その出力を OpenAPI の multipart-content リファレンスおよびこの issue の例と比較します。フォームフィールド、ネストされたオブジェクトと配列、エンコードされた画像データが、説明どおりに生成された仕様内で表現されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

question

Hello;

Is there a way to produce a spec of the type:
ref: https://spec.openapis.org/oas/latest.html#special-considerations-for-multipart-content

requestBody:
  content:
    multipart/form-data:
      schema:
        type: object
        properties:
          id:
            type: string
            format: uuid
          address:
            # default Content-Type for objects is `application/json`
            type: object
            properties: {}
          profileImage:
            # Content-Type for application-level encoded resource is `text/plain`
            type: string
            contentMediaType: image/png
            contentEncoding: base64
          children:
            # default Content-Type for arrays is based on the _inner_ type (`text/plain` here)
            type: array
            items:
              type: string
          addresses:
            # default Content-Type for arrays is based on the _inner_ type (object shown, so `application/json` in this example)
            type: array
            items:
              type: object
              $ref: '#/components/schemas/Address'
主要言語
Python
スター
1.2k
フォーク
210
平均マージ
2日 1時間
マージ済み PR（30日）
4

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

marshmallow-code/apispec のほかの issue

marshmallow-code/apispec の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。