Skip to content
This repository has been archived by the owner on Jun 14, 2021. It is now read-only.
/ slushy Public archive

🍦🍭Slushy is a framework for fully typed and validated APIs

Notifications You must be signed in to change notification settings

aimed/slushy

Repository files navigation

Build Status code style: prettier

🚧 Early prototype ahead 🚧

Slushy - fully typed and validated APIs 🍦🍭

Slushy uses OAS (OpenApi Specification) schemas to generate server boilerplate and validate server inputs and outputs. Slushy currently consist of the following parts:

  • @slushy/codegen Takes an OAS schema and generates typescript type definitions as well as @slushy/server boilerplate.
  • @slushy/server An opinionated NodeJS server based on an OAS schema with inputs/outputs validation and out of the box functionality such as api documentation.

To use slushy just follow three simple steps:

  • Define the OAS schema
  • Generate typescript types and server boilerplate
  • Run the server

Current features:

  • Input validation
  • Type generation
  • Route generation

Documentation

For documentation see https://aimed.github.io/slushy/.

Development

Coming up.

About

🍦🍭Slushy is a framework for fully typed and validated APIs

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published