adonis-basic-api.md

AdonisJS: Simple API Cheatsheet

A cheatsheet to help you as you build a simple API using AdonisJS framework for NodeJS.

Important Links

• NodeJS
• AdonisJS Documentation
• AdonisJS CLI Commands
• Knex ORM for NodeJS
• API Primer
• MySQL
• MySQL Workbench
• Git
• Postman
• http Status Codes

My Contact Info

• Twitter: @patrickodacre
• Website: BuildtoLearn.io

Project Overview

• Customers -- name, description
• Projects -- name, description, customer_id
• Tasks -- name, description, project_id

Common Mistakes

These mistakes are a common source for my bugs:

• forgetting the 'await' keyword
• creating migrations in the wrong order

Understanding Models and the Query Builder

• Lucid's Model Class path to file: /node_modules/@adonisjs/lucid/src/Lucid/Model/index.js
• Lucid Documentation
• Query Builder Documentation

Further Study

• Soft deletes (mentioned in the video on migrations)

Suggestions for More Practice

1. Practice using migrations to add / delete tables and columns after you've interacted with the database a while.
2. Can you use seeders to populate new columns added to an existing customers table or projects table?
3. What's another way to handle the routing so you don't have to write GET, POST, etc. individually? hint: Watch out on the delete() method!
4. How would you use the query builder to JOIN tasks to a project you want to GET using the show() method?
5. How would you use Lucid to define the relationship between Projects and Tasks so you can load Projects WITH tasks?
6. How can you implement basic authentication?

API Primer URL is not working currently.