Giter VIP home page Giter VIP logo

ts-rest-example's Introduction

ts-rest example

Features

  • ts-rest
  • OpenAPI Spec endpoint
  • Swagger-UI
  • Basic Authentication
  • Healthcheck endpoint
  • Logging logstash format
  • Logging daily rotate(Option)
  • Error email(Option)

Prerequisites

  • Node.js v18

Procedure

$ npm install
$ cd packages/contract
$ npm run build
$ cd -
$ npm start
cd packages/test-client
$ npm run client

> @foo-api/[email protected] client
> ts-node client.ts

{
  id: 'clhl7i11u0000ud38s7nadq31',
  createdAt: '2023-05-12T23:45:33.906Z',
  updatedAt: '2023-05-12T23:45:33.906Z',
  title: 'Post Title',
  content: 'Post Content',
  description: null,
  published: false,
  tags: [],
  image: null
}

Swagger-UI

http://localhost:3000/api

OpenAPI Spec response

http://localhost:3000/api-json

healthcheck

http://localhost:3000/health

TODO

  • Authentication
  • Logging

Reference

ts-rest-example's People

Contributors

chibat avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.