IPFS APIでデータアップロードする方法

概要

IPFSノードを立ち上げデータをアップロードする方法の紹介です。

IPFSは分散型ストレージでNFTの画像や音楽データを主に保存しています。

将来は主流のデータ保存ストレージになる大変注目度の高い技術です。

IPFSノードにデータ(ファイルや画像など)を保存

/api/v0/add

IPFSにファイルやディレクトリを追加する。

引数

Request Body

引数のパスはファイル・タイプです。このエンドポイントは、'multipart/form-data'としてリクエストのボディに1つまたは複数のファイル（コマンドに依存）を期待します。

addコマンドはファイルを追加するだけでなく、ディレクトリや複雑な階層をアップロードすることもできます。

これは次のように行われる： マルチパートリクエストの各部分は、IPFSに追加するディレクトリまたはファイルです。

ディレクトリパートは特別なコンテントタイプapplication/x-directoryを持つ。これらのパートはデータを持たない。パートヘッダーは以下のようになる：

Content-Disposition: form-data; name="file"; filename="folderName"
Content-Type: application/x-directory

ファイル・パートは、以下のヘッダーの後にファイル・ペイロードを運ぶ：

Abspath: /absolute/path/to/file.txt
Content-Disposition: form-data; name="file"; filename="folderName%2Ffile.txt"
Content-Type: application/octet-stream

...contents...

上記のファイルは "folderName/file.txt "階層にパスを含むので、IPFSはそれを "folderName "の中に追加することができる。ディレクトリを宣言する部分は、中にファイルがある場合は任意であり、ファイル名から推測される。どのような場合でも、ディレクトリツリーの深さ優先探索は、 リクエストを生成する異なるパーツを順番に並べるために推奨される。

Abspathヘッダーはnocopyオプションで有効になっているfilestore/urlstore機能のために含まれ、ファイルシステム内のファイルの場所(IPFSルート内)、または完全なWeb URLに設定することができます。

Response

成功すると、このエンドポイントへの呼び出しは、200と次のボディで返されます：

{
  "Bytes": "<int64>",
  "Hash": "<string>",
  "Name": "<string>",
  "Size": "<string>"
}

cURL Example

curl -X POST -F file=@myfile "http://127.0.0.1:5001/api/v0/add?quiet=<value>&quieter=<value>&silent=<value>&progress=<value>&trickle=<value>&only-hash=<value>&wrap-with-directory=<value>&chunker=size-262144&raw-leaves=<value>&nocopy=<value>&fscache=<value>&cid-version=<value>&hash=sha2-256&inline=<value>&inline-limit=32&pin=true&to-files=<value>"

データを公開

/api/v0/name/publish

IPNS名を公開する。

引数

Response

成功すると、このエンドポイントへの呼び出しは、200と次のボディで返されます

{
  "Name": "<string>",
  "Value": "<string>"
}

cURL Example

curl -X POST "http://127.0.0.1:5001/api/v0/name/publish?arg=<ipfs-path>&key=self&resolve=true&lifetime=48h0m0s&ttl=1h0m0s&quieter=<value>&v1compat=true&allow-offline=<value>&ipns-base=base36"

データの反映確認

/api/v0/name/resolve

IPNS名を解決する。

引数

Response

成功すると、このエンドポイントへの呼び出しは、200と次のボディで返されます：

{
  "Path": "<string>"
}

cURL Example

curl -X POST "http://127.0.0.1:5001/api/v0/name/resolve?arg=<name>&recursive=true&nocache=<value>&dht-record-count=16&dht-timeout=1m0s&stream=<value>"