APIs Design

[Zain-ul-din]

APIS Design Document

Introduction

Randomsts is a free and open-source framework for building restful APIS using typescript and class-based object-oriented programming.

Key Features

• File-base routing.
• Hot-reloading.
• Type safety.
• Intuitive APIs.

APIs Design General Thoughts

• client class will extend class Router to initialize the route.
• client class must have a ts-decorator @init() to emit meta data about file.
• override base methods to create APIs controller.
• export default instance of the class.

Example

import Route from 'pkg'

@Route.init ()
class ClientRoute extends Route 
{
    public async get (req: RequestType, res: ResponseType): Promise<void> {
        res.send ("hello world");
    }
}

export = new ClientRoute ();

@zainuldeen working...