Feat: Todo List `REST API`

[nelsonic]

Once deployed to Fly.io with CI/CD #52 and auth is added #37
we should add a basic REST API endpoint to CRUD Todo List items.

Why?

As part of building a full-stack App using our chosen Tech Stack https://github.com/dwyl/technology-stack#the-petal-stack
We want to build the backend API in Phoenix.
This mini tutorial is the perfect place to showcase building such an API because all the ground-work is already done for Todo list items.

Todo

• in the same Phoenix App, create a new api_controller.ex for CRUD-ing the Todo list items (you can use :pipe_through :json).

  Remember our objective is to leverage as much of the existing work in this repo as possible. 🙏

• Create an API Endpoint for Creating a new todo list item and test it via cURL (or Postman)
  • Should accept a JSON payload with the necessary data, e.g:
  1. person_id (Int)
  2. status (Int)
  3. text (String)

phoenix-todo-list-tutorial/lib/app/todo/item.ex

Lines 5 to 8 in e945ed2

	schema "items" do
	field :person_id, :integer, default: 0
	field :status, :integer, default: 0
	field :text, :string

• Should create a new Todo item if the data is valid

• Create a REST API Endpoint for editing the Todo list item.text:

  • Signature: POST /items/:id/
  • Should accept the item.id (Int) and item.text (String) and return 200 if successful. 🆗

• Create REST API Endpoint for Updating the status of the item i.e. setting it to "done" ✅

Relevant Learning

Please read: https://github.com/dwyl/phoenix-content-negotiation-tutorial 👀
And if you have any questions regarding content negotiation please open an issue. 🆕

For this project we don't need to have all the same routes we just need:

1. Create 🆕
2. Edit 📝
3. Update status ✅

[nelsonic]

@LuchoTurtle assigning this to you. But if anything is unclear please comment. 💬 🙏

[nelsonic]

@LuchoTurtle please see: dwyl/hits#168 🔗