Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

@furystack/rest

Package Overview
Dependencies
2
Maintainers
1
Versions
80
Issues
File Explorer

Advanced tools

@furystack/rest

Generic REST package

    4.0.2latest

Version published
Maintainers
1
Yearly downloads
6,750
increased by25.7%

Weekly downloads

Readme

Source

REST

REST API Model package for FuryStack

Generic concept

An ideal way to implement REST APIs in FuryStack is the following:

  1. Design the REST API - Create an interface that defines all endpoints, all requirements and all possible return values (~this package) You can place in a common module in a Monorepo that can be accessed both with the Backend and Frontend logic to share the API definition
  2. Implement the defined API endpoint using the interface on the backend service ([email protected]/rest-service)
  3. Import the predefined interface and use it on the client (@furystack/rest-client-fetch of @furystack/rest-client-got packages)
  4. Be happy. Type safety can protect your ass if you do breaking changes with your REST API

Disclaimer

  1. Your service and client will be tightly coupled. However it can be beneficial if this is intentional but it doesn't fin in all REST API scenarios
  2. Validation doesn't come with type definitions by default - Type safety is compile-time only

Keywords

FAQs

What is @furystack/rest?

Generic REST package

Is @furystack/rest popular?

The npm package @furystack/rest receives a total of 15 weekly downloads. As such, @furystack/rest popularity was classified as not popular.

Is @furystack/rest well maintained?

We found that @furystack/rest demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 04 May 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc