Skip to content

Latest commit

 

History

History
192 lines (150 loc) · 2.08 KB

api.md

File metadata and controls

192 lines (150 loc) · 2.08 KB
Raw

api document

/api/auth/register

  • Method: POST
  • Header: None
  • Body:
{
  "email": "fake@gmail.com",
  "password": "12345678",
  "confirmPassword": "12345678"
}
  • Param: None
  • Success Response:
{
  "error": false,
  "message": "Registration successful"
}
  • Error Response:
{
  "error": true,
  "message": "register failed"
}

/api/auth/login

  • Method: POST
  • Header: None
  • Body:
{
  "email": "fake@gmail.com",
  "password": "12345678"
}
  • Param: None
  • Success Response:
{
  "error": false,
  "message": "Login successful"
}
  • Error Response:
{
  "error": true,
  "message": "password not match" // the error message
}

/api/image/new

  • Method: POST
  • Header: Cookie : the jwt token sent by server after success authenticate
  • Body:
{
  "isPrivate": true,
  "file": "Image created"
}
  • Param: None
  • Success Response:
{
  "error": false,
  "message": ""
}
  • Error Response:
{
  "success": true,
  "message": "Some error occurs."
}

/api/image/update

  • Method: POST
  • Header: Cookie : the jwt token sent by server after success authenticate
  • Body:
{
  "isPrivate": true,
  "imageId": "123"
}
  • Param: None
  • Success Response:
{
  "error": false,
  "message": "Image updated"
}
  • Error Response:
{
  "success": true,
  "message": "Some error occurs."
}

/api/image/delete

  • Method: POST
  • Header: Cookie : the jwt token sent by server after success authenticate
  • Body:
{
  "imageId": "123"
}
  • Param: None
  • Success Response:
{
  "error": false,
  "message": "Image deleted"
}
  • Error Response:
{
  "success": true,
  "message": "Some error occurs."
}

/api/image/get

  • Method: GET
  • Header: Authorization: Bearer {jwt}
  • Body:
{
    "_body": ... // the actual image file
}
  • Param: None
  • Success Response:
{
  "success": false,
  "message": ""
}
  • Error Response:
{
  "success": true,
  "message": "Some error occurs."
}