stbk-server v1.3.3

Install

yarn add stbk-server

Description

Пакет позволяет выстроить простую архитектуру для REST API

Создайте в коренном каталоге папку routers

Каждая папка будет означать название пути запроса, как например папка user создаст путь /user

Каждый файл внутри означает метод запроса, как например файл get.ts в папке /user, отвечает за обработку запроса GET /user

Папка начинающаяся с : означает динамический роутер, как например папка :id в папке user позволит получить значение 1qa2ws3ed из роутера user/1qa2ws3ed (значение содержится в request.params.id)

index.ts файл внутри директории отвечает за метаинформацию и подключаемые middleware

RIP

• Экспорты внутри файлов должны быть дефолтными

• Изменить папку с API можно через параметр

Basic Usage

server.ts

import { Server } from 'stbk-server'

const server: Server = new Server({

  port: 5000,

  host: 'localhost',

  statics: ['/uploads']

})

server.start()

index.ts

import { Controller } from 'stbk-server'
import { TestMdwr } from '~/middleware'

export class UserController extends Controller {

  public middlewares = [TestMdwr]

  public description = 'Привет это описание'

}

export default UserController

get.ts

import { Route } from 'stbk-server'
import TestMdwr from '../middleware'

export const IndexGetRoute: Route = new Route((request, response) => {

  response.send('Привет')

}, [TestMdwr])

export default IndexGetRoute