auxcoder / express-basic-api

A Express Prisma rest API

README

Install

Create a Sqlite DB for development

$ sqlite3 test.db

Install and run

npm install
npm start

---

Running tests

Currently to make sure that your tests doesn’t listen “twice” from the server.js a check is done

if (!module.parent) {
  app.listen(port);
}

Another options is using Nodemon, as a npm package script:

"test": "nodemon --exec \"mocha --recursive\""

---

JWT

JSON Web Token Claims

---

Logs

Logs gets written to file from level debug and up in the all-logs.log files under /logs dir. Errors get logged too into errors.log files. Related logic in /core/logger, using Winston.

TODO:

• Jwt Authentication Tutorial With Example Api

• Using Jwt With Passport Authentication

• Authentication In Spa

• Module Best Practices

• Authentication PERN

• ACL / Roles + Permissions

• Access Control Lists for Node

• Role and Attribute based Access Control

• Assert NodeJS

• Tests, Superagent

Refs

• Git Flow
• Building A Node Js Rest Api With Express - Part 1
• Building A Node Js Rest Api With Express - Part 2
• Express API ES6 Starter
• Building a Node.js REST API with Express

Libs & Modules

• SQLite
• express-validator
• Validator
• strong-error-handler
• http-errors
• WinstonJS

---

Project structure

├── config                # App configuration files
│  ├─ serviceOne.json     # ServiceOne config
│  └─ ...                 # Other configurations
├── core                  # Business logic implementation
│  ├─ accounts.js
│  ├─ sales.js
│  ├─ comments.js
│  └─ ...                 # Other business logic implementations
├── logs
│  ├─ all-logs.log        # all logs
│  └─ error-logs.log      # error logs
├── prisma                # Prisma ORM
│  ├─ migrations
│  │  ├─ migration_<name>   # Migrations
│  │  └─ migrations_lock.toml # sqlite DB
│  ├─ accounts.js
│  └─ dev.db              # sqlite DB
├── db                    # Data access stuff
│  └─ prisma.js           # DB instantiation
├── routes
│  ├─ controllers         # Request managers
│  ├─ middleware         # Request middleware
│  └─ routes.js           # Define routes here
├── types              # External services implementation
│  ├─ ...
│  └─ common.js                 # Other services
├─ utils                  # Util libs (formats, validation, etc)
├─ tests                  # Testing
├─ scripts                # Standalone scripts for dev uses
├─ pm2.js                 # pm2 init
├─ package.json
├─ README.md
└─ app.js                 # App starting point

---

HTTP status codes

http-errors

• 200  OK, The request was successful
• 201  CREATED, A new resource object was successfully created
• 404  NOT FOUND, The requested resource could not be found
• 400 BAD REQUEST, The request was malformed or invalid
• 500  INTERNAL SERVER ERROR, Unknown server error has occurred

---

express-basic-api's Issues

Run Unit tests for User controller endpoints

Unit tests for:

• get/users
• get/users/id
• del/users/id
• patch/users/id
• post/users/id

Build migration Seed to run tests

Build a seed script to populate Data Base

• Todo
• User
• Token

Update dependencies

Update/Upgrade dependencies to avoid vulnerabilities

Run Unit tests for Auth controller endpoints

Migrate Bookshelf to Prisma ORM

Migrate ORM from Bookshelf to Prisma

Test Auth controller endpoints

• /register
• /login
• /verify
• /exist/:email

Test User controller endpoints

• get/users
• get/users/id
• del/users/id
• patch/users/id
• post/users/id

Run Unit tests for Todo controller endpoints

Test Todo controller endpoints

• get/todos
• get/todo/id
• del/todo/id
• patch/todo/id
• post/todo/id