migraf / typescript-rest-api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TRAPI - TypeScript Rest API 🌌

main codecov Known Vulnerabilities

What is it?

TRAPI is a small collection of few standalone as well helper libraries, to simplify the process of creating REST-APIs, generating documentations and communicating between frontend and backend application.

Installation

Please follow the README.md instructions in the respective package folder.

Packages

The repository contains the following packages:

trapi

npm version

This is the main package and contains the core functions of all other package and a CLI to interact with them.

README.md

@trapi/metadata

npm version

This package contains all functions, to generate metadata for TypeScript REST decorators. In most cases, the first thing to do is to generate metadata information by consulting self defined or third party REST decorators present on your code. The next step would either be, to generate a documentation according to the OpenAPI Specification or to create route schema/handling by using the Metadata for libraries like: express, koa, etc.

README.md

@trapi/query

npm version

This is a library for building JSON:API like REST-APIs. It extends the specification format between request- & response-handling for querying and fetching data.

@trapi/swagger

npm version

This package contains all functions, to generate a fully featured documentation according the OpenAPI Specification from given metadata.

README.md

@trapi/utils

npm version

This Package contains all util functions, which are also partially required by other modules of this repository.

README.md

About

License:MIT License


Languages

Language:TypeScript 99.0%Language:JavaScript 1.0%