Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sroehrl/node-express-typescript
Micro framework to be used as a boilerplate for rapid API development.
https://github.com/sroehrl/node-express-typescript
api-rest continuous-integration express jest typescript
Last synced: 5 days ago
JSON representation
Micro framework to be used as a boilerplate for rapid API development.
- Host: GitHub
- URL: https://github.com/sroehrl/node-express-typescript
- Owner: sroehrl
- License: mit
- Created: 2020-12-20T03:42:46.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-20T23:33:19.000Z (over 3 years ago)
- Last Synced: 2023-03-02T10:33:02.600Z (over 1 year ago)
- Topics: api-rest, continuous-integration, express, jest, typescript
- Language: TypeScript
- Homepage:
- Size: 104 KB
- Stars: 17
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Express api server w/ typescript
[](https://codeclimate.com/github/sroehrl/node-express-typescript/maintainability)
[](https://codeclimate.com/github/sroehrl/node-express-typescript/test_coverage)
[](https://travis-ci.com/sroehrl/node-express-typescript)
A clean setup/boilerplate for your REST Api. This repo is aimed at providing developers with
a testable, easy to use structure for rapid API development.
- typescript
- express
- MySQL & orm & migration
- route loading
- jest
- JWT authentication
- yarn
## Content
- [Installation & Setup](#installation--setup)
- [Authentication](#authentication)
- [Routing & Resolving](#routing-and-resolving)
## Installation & Setup
_Note:_ typescript und yarn are ideally installed globally
- After cloning, run `yarn install`
- Create a MySQL database for your project
- Copy `.env_example` to `.env` and adjust its variables accordingly.
- **optional**: adjust _models/user/migration.js_ and _models/user/UerInterface.ts_ to your needs
- run `node migrate` to write table(s) to your database
- run `yarn start`
## Authentication
This package includes authentication middleware for JWT authentication. Authenticated endpoints
expect an authorization header.
_Register_
```javascript
// example
fetch('http://localhost:3000/api/auth', {
method: 'POST',
body: JSON.stringify({
password: '123456',
userName: 'demo993'
}),
headers: {
"Content-type": "application/json; charset=UTF-8"
}
})
```
_Login_
```javascript
// example
fetch('http://localhost:3000/api/login', {
method: 'POST',
body: JSON.stringify({
password: '123456',
userName: 'demo993'
}),
headers: {
"Content-type": "application/json; charset=UTF-8"
}
})
.then(j => j.json())
.then(result => {
// retrieve JWT token
const JWT = result.token;
})
```
_Making authenticated calls_
```javascript
// example
fetch('http://localhost:3000/api/protected', {
method: 'GET',
headers: {
"Content-type": "application/json; charset=UTF-8",
"Authorization": `bearer ${yourToken}`
}
})
.then(j => j.json())
.then(result => {
console.log(result)
})
```
## Models
Models expect a migration.js in order to sync database tables.
Let's have a look at the user model as an example
```javascript
const base = {
user:{ // table name
id: 'binary(16) NOT NULL',
userName: 'varchar(40) DEFAULT NULL',
password: 'varchar(255) DEFAULT NULL',
createdAt: 'timestamp NULL DEFAULT current_timestamp()',
deletedAt: 'datetime DEFAULT NULL'
},
user_role:{} // another table
}
module.exports = {
base,
migrations: [] // alterations to existing models should be placed in migrations array
}
```
Simple models (one db table) do not need a model class and can simply be created at runtime
using /utils/resolver.ts _(used in all auth routes)_
## Routing and Resolving
Files in /src/routes are loaded automatically.
```javascript
// e.g. /src/routes/comments.ts
import {Express, Request, Response} from 'express-serve-static-core';
import Resolver from "../utils/resolver";
import {Model} from "../models/Model";
const Comment = new Resolver(new Model('comment'));
export default (app: Express) => {
// GET /api/comment/{id} gets a comment (assuming comment model exists) by id
app.get('/api/comment/:id', Comment.get)
}
```