saidqb / adonisjs-rest-api

adonisjs rest api, with api-key, access_token and sample CRUD user, post

Adonis-Js Rest Api

Version Framework: 6

Description:

Full Documentation Adonisjs

Fork From AdonisJS-6-REST-API Banyak perubahan dan modifikasi dari fork

Clone and Work, Using adonis js Framework

Requirements:

• Node.js >= 20.6

Avilable Database

• Mysql

Features:

• User Authentication (Access Token)
• User Authorization (Bouncer) :: abilities, policies
• Database (Lucid)
• Validation (VineJS)
• Middleware
• Exception Handling :: not found, unauthorized access, unauthorized action (Bouncer), validation error (VineJS), custom database error (Lucid)
• CRUD :: configs, user_roles, user_statuses, users, access_tokens, posts
• Helper
• Constant
• Date (luxon)
• Core :: handler controller
• Filter query params

VSCODE Extension:

Command pallate F1 Vscode

AdonisJS VSCode extension
Edge VSCode extension
Japa VSCode extension

command cheatsheet

hanya bantuan sekilas

App-key

node ace generate:key 

Controller

node ace make:controller users

Menggunakan library lucid

Migration

node ace make:migration users
# CREATE: database/migrations/1630981615472_users.ts

node ace migration:run

# Rollback the latest batch
node ace migration:rollback

# Rollback until the start of the migration
node ace migration:rollback --batch=0

# Rollback until batch 1
node ace migration:rollback --batch=1

node ace migration:reset

node ace migration:refresh

# Refresh the database and run all seeders
node ace migration:refresh --seed

Seeder

node ace make:seeder User

# runs all
node ace db:seed
# runs Specified file
node ace db:seed --files "./database/seeders/user_seeder.ts"
# Interactive mode
node ace db:seed -i

Model

node ace make:model User
# CREATE: app/Models/User.ts


node ace make:model User -m
# CREATE: database/migrations/1618903673925_users.ts
# CREATE: app/Models/User.ts

node ace make:model User -f
# CREATE: app/Models/User.ts
# CREATE: database/factories/User.ts

View

node ace make:view email/test

advance

node ace make:command greet

postman

postman

Akses Api

Api-Key: <yor api key>

Akses data login

Authorization: Bearer <token>

token didapat dari login

postman response default

display single data

{
  "status": 200,
  "success": true,
  "error_code": 0,
  "message": "success",
  "data": {
      "item": {}
  }
}

display multiple data

{
  "status": 200,
  "success": true,
  "error_code": 0,
  "message": "success",
  "data": {
      "items": [],
      "pagination" : {}
  }
}

Query Params Doc

DOC

Filter Query By Field

Key	Name	Result
eq	equal	field = 'value'
neq	not equal	field != 'value'
lt	lower than	field < 'value'
gt	greater than	field > 'value'
lte	lower than equal	field <= 'value'
gte	greater than equal	field >= 'value'
le	like end	field LIKE 'value%'
ls	like start	field LIKE '%value'
lse	like start end	field LIKE '%value%'
in	where IN	field IN (value) value diberi sparator , contoh 1,2,3,4 / 1
nin	where NOT IN	field NOT IN (value) value diberi sparator , contoh 1,2,3,4 / 1

Avilable Param

1. Sort => sort=-user_name => SORT user_name DESC
2. Sort => sort=user_name => SORT user_name ASC
3. Sort => field sort sesuai dengan result
4. Limit => default 10
5. Page => default 1
6. search => search=keyword

COFFEE FOR BEST PERFORMANCE

COFFEE HERE for more inovation

OR