Skip to content

SCKelemen/msTodo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

msTodo

msTodo is a microservice plugin for the framework which exposes methods for Todo Items and lists. msTodo follows the CRAP schema, and it's RESTful HTTP methods are paired below.

CRAP Verb HTTP Verb
Create POST
Retrieve GET
Alter PATCH/PUT
Purge DELETE
SHIT Verb HTTP Verb
Set PATCH/PUT
Hail GET
Initialize POST
Terminate DELETE

Install

$ go get
$ go run main.go

API Routes

LISTS

CRAP Verb HTTP Verb Route Example Description
Create POST "/l" POST "/l" Creates a List
Retrieve GET "/l", "/l/:id" GET "/l/123" Retrieves List with ID, otherwise returns all lists
Alter PATCH "/l/:id" PATCH "/l/123" Alters List with ID
Purge DELETE "/l/:id" DELETE "/l/123" Purges List with ID

TODOS

CRAP Verb HTTP Verb Route Example Description
Create POST "/t" POST "/t" Creates a Todo item
Retrieve GET "/t/:id" GET "/t/123" Retrieves Todo item with ID
Alter PATCH "/t/:id" PATCH "/t/123" Alters Todo item with ID
Purge DELETE "/t/:id" DELETE "/t/123" Purges Todo item with ID

LABELS

CRAP Verb HTTP Verb Route Example Description
Create POST "/z" POST "/z" Creates a Label
Retrieve GET "/z/:id" GET "/z/123" Retrieves Label with ID
Alter PATCH "/z/:id" PATCH "/z/123" Alters Label with ID
Purge DELETE "/z/:id" DELETE "/z/123" Purges Label with ID

CATEGORIES

CRAP Verb HTTP Verb Route Example Description
Create POST "/c" POST "/c" Creates a Category
Retrieve GET "/c/:id" GET "/c/123" Retrieves Category with ID
Alter PATCH "/c/:id" PATCH "/c/123" Alters Category with ID
Purge DELETE "/c/:id" DELETE "/c/123" Purges Category with ID

STATUSES

CRAP Verb HTTP Verb Route Example Description
Create POST "/s" POST "/s" Creates a Status
Retrieve GET "/s/:id" GET "/s/123" Retrieves Status with ID
Alter PATCH "/s/:id" PATCH "/s/123" Alters Status with ID
Purge DELETE "/s/:id" DELETE "/s/123" Purges Status with ID

COMMENTS

CRAP Verb HTTP Verb Route Example Description
Create POST "/x" POST "/x" Creates a Comment
Retrieve GET "/x/:id" GET "/x/123" Retrieves Comment with ID
Alter PATCH "/x/:id" PATCH "/x/123" Alters Comment with ID
Purge DELETE "/x/:id" DELETE "/x/123" Purges Comment with ID

REACTIONS

CRAP Verb HTTP Verb Route Example Description
Create POST "/r" POST "/r" Creates a Reaction
Retrieve GET "/r/:id" GET "/r/123" Retrieves Reaction with ID
Alter PATCH "/r/:id" PATCH "/r/123" Alters Reaction with ID
Purge DELETE "/r/:id" DELETE "/r/123" Purges Reaction with ID

USERS

CRAP Verb HTTP Verb Route Example Description
Create POST "/u" POST "/u" Creates a User
Retrieve GET "/u/:id" GET "/u/123" Retrieves User with ID
Alter PATCH "/u/:id" PATCH "/u/123" Alters User with ID
Purge DELETE "/u/:id" DELETE "/u/123" Purges User with ID

About

Todo microservices

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages