Skip to content

IPFS server API simulator for a quick start to interact with an IPFS server.

License

Notifications You must be signed in to change notification settings

yepengding/IPFSServerAPISimulator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

IPFS Server API Simulator

A simple IPFS server API simulator for a quick start to interact with an IPFS server.

Commands

Compile

mvn package

Run

java -jar *.jar

API

http://localhost:5001/swagger-ui/

Contact information:
Yepeng Ding
https://yepengding.github.io/

License: MIT License

/ipfs/list

GET

Summary:

listFiles

Responses
Code Description Schema
200 OK CommonResult«List«string»»
403 Forbidden
500 Internal Error

/ipfs/upload

POST

Summary:

uploadFile

Parameters
Name Located in Description Required Schema
file body file Yes binary
Responses
Code Description Schema
200 OK CommonResult«IPFSFile»

/ipfs/{cid}

GET

Summary:

getFileByCID

Parameters
Name Located in Description Required Schema
cid path cid Yes string
Responses
Code Description Schema
200 OK Resource
403 Forbidden
500 Internal Error

Models

CommonResult«IPFSFile»

Name Type Description Required
code long No
data IPFSFile No
message string No

CommonResult«List«string»»

Name Type Description Required
code long No
data [ string ] No
message string No

IPFSFile

Name Type Description Required
cid string No
integrity string No
size long No
timestamp long No

InputStream

Name Type Description Required
InputStream object

Resource

Name Type Description Required
description string No
file file No
filename string No
inputStream InputStream No
open boolean No
readable boolean No
uri string (uri) No
url string (url) No

Reference

About

IPFS server API simulator for a quick start to interact with an IPFS server.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published