https://github.com/lyaricci/api_todolist_rails
This is an example of a todolist API in Rails
https://github.com/lyaricci/api_todolist_rails
api-rest learning-by-doing rails ruby ruby-on-rails
Last synced: about 2 months ago
JSON representation
This is an example of a todolist API in Rails
- Host: GitHub
- URL: https://github.com/lyaricci/api_todolist_rails
- Owner: lyaricci
- Created: 2023-11-28T21:04:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-28T21:58:08.000Z (over 2 years ago)
- Last Synced: 2025-10-26T12:38:12.925Z (8 months ago)
- Topics: api-rest, learning-by-doing, rails, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Todolist Ruby on Rails
This is a simple example of a todolist API created with Ruby on Rails.
## Endpoints
> *All endpoints return JSON.*
### GET /tasks
Returns a list of tasks.
### GET /tasks/:id
Returns a task by its id.
### GET /tasks/completed
Returns a list of tasks marked as completed.
### GET /tasks/incomplete
Returns a list of tasks marked as incomplete.
### POST /tasks
Creates a new task. Parameters:
- *required* `title` (string): The task title
- *optional* `description` (string): The task description
- *required* `completed` (boolean): Whether the task is completed or not
### PATCH /tasks/:id
Updates a task. Parameters:
- *required* `title` (string): NEW task title
- *optional* `description` (string): NEW task description
- *required* `completed` (boolean): NEW task status
### DELETE /tasks/:id
Deletes a task.