README.md

API PAYLOAD & RESPONSE

• MockAPI
  • Get
  • Post
• Authen
  • Auth
  • Insert user
• Group
  • Get all group
  • Get one group
  • Create group
  • Update group name
  • Delete group
• Items
  • Get one item
  • Create item
  • Update item
  • Delete item

Mock API

• Mock (GET)

http://xxxxxxxxxx/v1/mock

Response

[
    {
        "id": 1,
        "name": "MockGroupName1",
        "created_at": "2025-03-18 01:00:00"
    },
    {
        "id": 2,
        "name": "MockGroupName2",
        "created_at": "2025-03-18 02:00:00"
    },
    {
        "id": 3,
        "name": "MockGroupName3",
        "created_at": "2025-03-18 03:00:00"
    }
]

• Mock (POST)

http://xxxxxxxxxx/v1/mock

Payload

{
    anything
}

Response

"You send <Your payload> to me."

Authen

• Auth (POST)

http://xxxxxxxxxx/v1/auth

Payload

{   
    user: string,
    password: string
}

Response

{
    token: string
}

• Insert user (POST)

http://xxxxxxxxxx/v1/user

Payload

{   
    user: string,
    password: string
}

Response

{
    success: boolean
}

Group

• Get all group (GET)

http://xxxxxxxxxx/v1/groups

Header

{
	...,
    Authorization: `Bearer ${token}`
}

Response

[
	{
		id: integer,
		name: string,
		created_at: data-time
	},...
]

• get one group (GET)

http://xxxxxxxxxx/v1/group/:id

Header

{
	...,
    Authorization: `Bearer ${token}`
}

Response

{
	groupName:  string,
	items:  [
		{
			id:  integer,
			name:  string,
			quantity:  integer,
			checked:  integer,
			created_at:  date time
		},
		...
	]
}

• create group (POST)

http://xxxxxxxxxx/v1/group

Header

{
	...,
    Authorization: `Bearer ${token}`
}

Payload

{
    name: string
}

Response

{
    success: boolean
}

• update group name (PUT)

http://xxxxxxxxxx/v1/group/:id

Header

{
	...,
    Authorization: `Bearer ${token}`
}

Payload

{
    name: string,
}

Response

{
    success: boolean
}

• delete group (DELETE)

http://xxxxxxxxxx/v1/group/:id

Header

{
	...,
    Authorization: `Bearer ${token}`
}

Response

{
    success: boolean
}

Items

• Get one item (GET)

http://xxxxxxxxxx/v1/item/:id

Header

{
	...,
    Authorization: `Bearer ${token}`
}

Response

{
	id:  integer,
	name:  string,
	quantity:  integer,
	checked:  integer,
	created_at:  date time
}

• create item (POST)

http://xxxxxxxxxx/v1/item

Header

{
	...,
    Authorization: `Bearer ${token}`
}

Payload

{
    name: string,
    quantity: integer,
    group_id: integer
}

Response

{
	success: boolean
}

• Update item (PUT)

http://xxxxxxxxxx/v1/item/:id

Header

{
	...,
    Authorization: `Bearer ${token}`
}

Payload

{
    name: string (optional),
    quantity: integer (optional),
    checked: integer (optional)
}

NOTE: at least one parameter in payload

Response

{
    success: boolean
}

• Delete item (DELETE)

http://xxxxxxxxxx/v1/item/:id

Header

{
	...,
    Authorization: `Bearer ${token}`
}

Response

{
    success: boolean
}