README.md

Mock API Documentation v1.0.0

Node.js Express Rest API for Mock API

Table of contents

• Figure
  • Create
  • Delete
  • Get
  • Get All
  • Update

---

Figure

Create

Back to top

POST /figures/

Request Body

Name	Type	Description
name	String	Name of the Figure
series	Number	Series of the Figure
move	String	Move of the Figure
year	Number	Year of the Figure
cardColor	String	Card Color of the Figure
accessories	String	Accessories of the Figure

Success response

Success response - Success 200

Name	Type	Description
id	String	ID of the Figure
name	String	Name of the Figure
series	Number	Series of the Figure
move	String	Move of the Figure
year	Number	Year of the Figure
cardColor	String	Card Color of the Figure
accessories	String	Accessories of the Figure

Delete

Back to top

DELETE /figures/:id

Parameters - Parameter

Name	Type	Description
id	String	Figures unique ID

Get

Back to top

GET /figures/:id

Parameters - Parameter

Name	Type	Description
id	String	Figures unique ID

Success response

Success response - Success 200

Name	Type	Description
id	String	ID of the Figure
name	String	Name of the Figure
series	Number	Series of the Figure
move	String	Move of the Figure
year	Number	Year of the Figure
cardColor	String	Card Color of the Figure
accessories	String	Accessories of the Figure

Get All

Back to top

GET /figures/

Success response

Success response - Success 200

Name	Type	Description
id	String	ID of the Figure
name	String	Name of the Figure
series	Number	Series of the Figure
move	String	Move of the Figure
year	Number	Year of the Figure
cardColor	String	Card Color of the Figure
accessories	String	Accessories of the Figure

Update

Back to top

POST /figures/:id

Parameters - Parameter

Name	Type	Description
id	String	Figures unique ID

Request Body

Name	Type	Description
name	String	Name of the Figure
series	Number	Series of the Figure
move	String	Move of the Figure
year	Number	Year of the Figure
cardColor	String	Card Color of the Figure
accessories	String	Accessories of the Figure

Success response

Success response - Success 200

Name	Type	Description
id	String	ID of the Figure
name	String	Name of the Figure
series	Number	Series of the Figure
move	String	Move of the Figure
year	Number	Year of the Figure
cardColor	String	Card Color of the Figure
accessories	String	Accessories of the Figure