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

@gerkirill/json-api-service

v1.0.1

Published

A library to simplify web API service creation, based on routing-controllers.

Downloads

3

Readme

JSON API Service

A library to simplify web API service creation. It relies on express and routing-controllers.

The library reduces a boilerplate to spin-up a rest API service. Also this library:

  • Sets up HEAD request handler (HEAD requests appear as a part of CORS workflow).
  • Handlers CORS but only in development (local) mode.
  • Handles HTTP errors and responds with proper JSON and HTTP status code.

Usage

Install library and required peer dependencies:

npm i @gerkirill/json-api-service routing-controllers@^0.10.4 class-transformer@^0.5.1 class-validator@^0.14.1 reflect-metadata
npm i -D @types/node typescript

Note: versions of class-transformer and class-validator are defined as peer dependencies of the routing-controllers^0.10.4.

Usage example:

import { createApplication } from '@gerkirill/json-api-service';
import { Get, JsonController } from 'routing-controllers';

const BASE_PATH = '/api';
const PORT = 5000;

@JsonController()
class HealthController {
  // http://localhost:5000/api/health/
  @Get('/health') 
  public async getHealth() {
    return { status: 'ok' };
  }
}

const app = createApplication({
  routePrefix: BASE_PATH,
  controllers: [HealthController],
  errorHandler: (error) => console.error(error),
});
app.listen(PORT, () => {
  console.log(`Server listening at port ${PORT}`);
});

Also, make sure the following compilerOptions are set in your tsconfig.json:

{
  "experimentalDecorators": true,
  "emitDecoratorMetadata": true
}

createApplication accepts configuration object with the following fields:

  • routePrefix (optional, string) A url fragment to be added to all controllers, e.g.: /api/v1.
  • controllers (array) Array of controller classes annotated with @Controller() or @JsonController().
  • middlewares (optional, array) Array of middleware classes to use globally.
  • interceptors (optional, array) Array of interceptors to use globally, annotated with @Interceptor().
  • earlyBootstrapFn (optional, function(app) => void) Function to execute on app before it is passed to useExpressServer().
  • errorHandler (optional, function(err) => void) A callback invoked by the custom HTTP error handler this library provides. If error handler is not set - errors are logged to console with console.error().

Contributing

Upon update of routing-controllers - make sure to update peer dependency versions in package.json (dev dependencies section) and in README. Also, you may get a warning like this one class-transformer 0.3.2 (0.5.1 is available) deprecated - please don't upgrade unless your version of routing-controllers requires exactly this version.