Transfer Module

Build Project

Requirements

1. Node >= 8.11.1(LTS)
2. PM2 installed globally

Install Dependency

yarn install
# or
npm install

Add Env Config

cp ./config/.env.example ./config/.env.prod

Compile Typescript

yarn run build
# or
npm run build

Deploy Project

pm2 start ./config/process.yml

APIs

Content Manage

Upload Content

URL

[POST] http://localhost:3000/files/create

Params

{
  "key": "hello_world", // string, required
  "content": "Hello World", // string, stream, required
  "forceFlag": 0 // integer, optional, 0 = false, 1 = true
}

Other

{
  "headers": {
    "Content-Type": "multipart/form-data"
  }
}

Returns

{
  "data": true,
  "message": "Success Message"
}
{
  "error": {
    "code": -1,
    "message": "Error Message"
  }
}

Get Content

URL

[GET] http://localhost:3000/files/show/hello_world

Params

None

Other

None

Returns

Return Content or error

{
  "error": {
    "code": -1,
    "message": "File Not Found"
  }
}

Send File To Remote

URL

[GET] http://47.97.171.140:3000/files/send

Params

{
  "key": "hello_world", // string, required
  "orgId": "orgId" // string, required
}

Other

None

Returns

Same as Create Method

Orgs Management

Add Org

URL

[POST] http://47.97.171.140:3000/orgs/create

Params

{
  "orgId": "orgId", // orgId
  "addr": "http://127.0.0.1:3000/files/create" // remote address
}

Other

None

Returns

{
  "data": true
}
// or
{
  "error": {
    "code": -1,
    "message": "error message"
  }
}

Update Org

URL

[POST] http://47.97.171.140:3000/orgs/update

Params

{
  "orgId": "orgId", // orgId
  "addr": "http://127.0.0.1/files/create:3000" // remote address
}

Other

None

Returns

{
  "data": true
}
// or
{
  "error": {
    "code": -1,
    "message": "error message"
  }
}

Delete Org

URL

[POST] http://47.97.171.140:3000/orgs/delete

Params

{
  "orgId": "orgId" // orgId
}

Other

None

Returns

{
  "data": true
}
// or
{
  "error": {
    "code": -1,
    "message": "error message"
  }
}

Get Org

URL

[GET] http://47.97.171.140:3000/orgs/show/:orgId

Params

None

Other

None

Returns

{
  "data": "remote addr"
}
// or
{
  "error": {
    "code": -1,
    "message": "error message"
  }
}

List Org

URL

[GET] http://47.97.171.140:3000/orgs/index

Params

None

Other

None

Returns

{
  "data": [
    {
      "orgId": "orgId",
      "addr": "addr"
    }
  ]
}
// or
{
  "error": {
    "code": -1,
    "message": "error message"
  }
}