https://github.com/saidqb/adonisjs-rest-api
adonisjs rest api, with api-key, access_token and sample CRUD user, post
https://github.com/saidqb/adonisjs-rest-api
adonis adonis-api adonis-rest-api adonisjs node-js nodejs rest-api
Last synced: about 1 year ago
JSON representation
adonisjs rest api, with api-key, access_token and sample CRUD user, post
- Host: GitHub
- URL: https://github.com/saidqb/adonisjs-rest-api
- Owner: saidqb
- License: mit
- Created: 2024-07-02T04:03:42.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-15T06:38:45.000Z (almost 2 years ago)
- Last Synced: 2025-02-11T11:38:37.651Z (over 1 year ago)
- Topics: adonis, adonis-api, adonis-rest-api, adonisjs, node-js, nodejs, rest-api
- Language: TypeScript
- Homepage:
- Size: 174 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Adonis-Js Rest Api
Version Framework: 6
## Description:
[Full Documentation Adonisjs](https://docs.adonisjs.com/guides/preface/introduction)
Fork From [AdonisJS-6-REST-API](https://github.com/rayhannovelo/AdonisJS-6-REST-API/tree/main) 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)](https://lucid.adonisjs.com/docs/table-builder)
- Validation [(VineJS)](https://vinejs.dev/docs/types/string#defining-error-messages)
- 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)](https://moment.github.io/luxon/#/?id=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](https://lucid.adonisjs.com/docs/introduction)
### 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:
```
Akses data login
```
Authorization: Bearer
```
token didapat dari login
## postman response default
display single data
```json
{
"status": 200,
"success": true,
"error_code": 0,
"message": "success",
"data": {
"item": {}
}
}
```
display multiple data
```json
{
"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](https://saidqb.github.io/coffee)** for more inovation
OR
