npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@shevelidze/easyrest

v0.1.10

Published

A library for RESTing without a headache.

Downloads

1

Readme

Easyrest

Easyrest is a typescript library for building RESTful APIs without repeating yourself. It takes care about all aspects that cause a headache in a RESTful API developing process.

Easyrest offers:

  1. Simple entities architecture, which allows to design your api using small amount of code.
  2. Opportunity to use it with any possible web framework. It doesn't have any framework specific features.
  3. Opportunity to use different approaches to fetch data. For an every entity you have to provide a fetcher, mutator, and deleter functions. You decide how it will work inside.

Installation

You can install Easyrest using npm:

npm install @shevelidze/easyrest

Or using yarn:

yarn add  @shevelidze/easyrest

Basic usage

First of all you have to decide with the entities, which you will have in the api and develop fetcher for each. You can find out more about the fetchers in the Fetchers section.

Now, you can create an instance of EasyRest with entitity blueprints. Entity blueprint is a set of entitity members, methods and data manipulation functions.

import EasyRest from '@shevelidze/easyrest';

// add fetchers definitions here

const easyRest = new EasyRest.Instance({
  zoo: {
    members: {
      address: EasyRest.string(),
      workers: EasyRest.array(EasyRest.entity('worker')),
      animals: EasyRest.array(EasyRest.entity('animal')),
    },
    fetcher: zooFetcher,
  },
  worker: {
    members: {
      name: EasyRest.string(),
      birthDate: EasyRest.string(),
      salary: EasyRest.number(),
    }
    fetcher: workerFetcher,
  },
  animal: {
    members: {
      name: EasyRest.string(),
      type: EasyRest.entity('entimal_type')
    },
    fetcher: animalFetcher,
  },
  animal_type: {
    members: {
      name: EasyRest.string()
    },
    fetcher: animalTypeFetcher,
  }
});

For processing queries, EasyRest.Instance has a method processQuery. It take as arguments, query array (for request with a path /foo/bar/1, for example, it will be ['foo', 'bar', '1']), HTTP method and body object. The easiest way, use JSON for the body and than just convert it to an object, but you are free to use any other way.

When you get a request you have to call this method.

const apiResult = await easyRest.processQuery(queryArray, httpMethod, bodyObject);

If the request is invalid, this method will throw an instance of EasyRest.errors.EasyRestError, which will contain a HTTP code of the error and a message.

If not, it will return an instance of EasyRest.ApiResult, which contains a HTTP code and body for the response.

After all theese manipulations you can:

  • get all objects of the entity: GET /entities/worker[{id: "1", name: "John"... }, {id: "2", name: "Victor"...}]
  • get an object by id: GET /entities/animal/12{id: "12", name: "Lucky", type: {id: "2", name: "Dog"}}
  • get only one member of an object: GET /entities/animal/12/type{id: 2, name: "Dog"}