Categorygithub.com/readyyyk/todoAPI
modulepackage
0.0.1-beta
Repository: https://github.com/readyyyk/todoapi.git
Documentation: pkg.go.dev

# README

todoAPI

CodeFactor Go report

Custom error descriptions

CodeMeaning
0invalid data
1User with this email already exists
2user don't exists
3Wrong password
4JWT token is invalid
5Group don't exist
6User doesn't own this group

Routes

ActionMethodRoute
USER
Create userPOST<host>/api/users
Get user listGET<host>/api/users
Get user infoGET<host>/api/users/:id
Get user dataGET<host>/api/users/:id/data
Update user dataPOST<host>/api/users/:id
Delete userDELETE<host>/api/users/:id
LoginPOST<host>/api/users/login
GROUP
Create groupPOST<host>/api/groups
Delete groupDELETE<host>/api/groups/:id
TODO
Create todoPOST<host>/api/groups/:group_id
Delete todoDELETE<host>/api/groups/:group_id/todos/:todo_id

Provided data-sets

ActionReq. data
USER
Create userbody {"email" string, "name" string}
Get user listheader "X-admin-access"
Get user infonone
Get user dataJWT
Update user dataJWT, body {"email" string, "password" base64, "name" string }
Delete userJWT
Loginbody {"email" string, "password" base64}
GROUP
Create groupJWT, body {"title" string}
Delete groupJWT
TODO
Create todoJWT, body {"title" string, "text" string, "deadline" date}
Delete todoJWT

🚨 Will be added during writing tests

ActionResp. data
USER
Create user
Get user list
Get user info
Get user data
Update user data
Delete user
Login
GROUP
Create group
Delete group
TODO
Create todo
Delete todo

Files

ActionFileState
USER
Create user/user_post🚨 Need to be tested
Get user list/user_getList🦺 Need to be tested
Get user info/user_getInfo🦺 Need to be tested
Get user data/user_getData🚨 Need to be tested
Update user data/user_upd🦺 Need to be tested
Delete user/user_del🦺 Need to be tested
Login/user_login🚨 Need to be tested
GROUP
Create group/group_post🚨 Need to be tested
Delete group/group_delete🚨 Need to be tested
TODO
Create todo/todo_post🚨 Need to be tested
Delete todo/todo_delete🚨 Need to be tested

# Functions

No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author