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

rest-buddy

v0.3.5

Published

Resourceful Framework that's got your back

Downloads

3

Readme

rest-buddy Build Status Circle CI npm npm

Resourceful Framework that's got your back

Overview

RestBuddy is a light framework for creating JSON RESTy APIs. Currently it provides a middleware for Express, but could also provide one for Koa in the future. The overall design goals are:

  • Strong validation of request body, request parameters, and response body
  • Fast and easy to create standard REST endpoints, but not overly restrictive
  • Ability to procedurally generate documentation (perhaps in the future via Swagger)
  • Easily testable controller action handlers
  • Standard middleware that can be composed with other middleware in the standard fashion

RestBuddy is an instantiatable class that takes in it constructor

  • The resource name
  • A specification for actions (action name, method, url, validation schemas, human readable info)
  • A controller that exports action handlers

and provides getters for

  • Express middleware that serves the resource
  • The decorated specification (that includes generated REST actions)
  • (future) Human readable documentation in markdown
  • (future) Koa middleware that serves the resource

Usage

Idiomatic REST with no validations

A completely idiomtic REST endpoint (with no validation) would look like:

var app = require('express')(),
    RestBuddy = require('rest-buddy'),

    spec = {}, // RestBuddy autofills this for standard REST actions
    controller = {
        index:   function(req) { return {status: 200, data: {'ok'}}; },
        create:  function(req) { return {status: 200, data: {'ok'}}; },
        show:    function(req) { return {status: 200, data: {'ok'}}; },
        update:  function(req) { return {status: 200, data: {'ok'}}; },
        destroy: function(req) { return {status: 200, data: {'ok'}}; }
    },

    smurfsResource = new RestBuddy('smurfs', spec, controllers);

app.use(smurfsResource.middleware).listen(1337);

We can now use the following methods on the following URLs

GET    /smurfs    => 200 'ok'
POST   /smurfs    => 200 'ok'
GET    /smurfs/42 => 200 'ok'
PUT    /smurfs/42 => 200 'ok'
DELETE /smurfs/42 => 200 'ok'

Idiomatic REST with validations

Lorem

REST + custom actions

Lorem

Components

RestBuddy

Lorem

Specification

Lorem

Controller

Lorem

Development

Clone and install deps

npm i  

You can run tests one time

npm tst

Or you can run tests on changes

npm start

Build the final compiled lib with

npm run build