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

express-routing-controllers

v1.0.2

Published

To provide a convenient and intuitive way to define and use controllers in an Express.js application using decorators. It aims to simplify the process of building robust and scalable Express APIs by leveraging the power of decorators and providing a struc

Downloads

5

Readme

Express controllers

Express Controllers is an npm package that simplifies the process of extending the Express framework by providing a decorator-based approach for defining and organizing your routes using controllers.

With this package, you can easily structure and manage your API endpoints in a more modular and maintainable way.

Installation

To install express-routing-controllers, you can use npm or yarn:

npm install express-routing-controllers

or

yarn add express-routing-controllers

Usage

Here's an example of how to use Express Controllers in your express application:

const express = require("express");
const {
  registerControllers,
  Route,
  Get,
  Post,
  Params,
  Body,
} = require("express-routing-controllers");

const app = express();
const port = process.env.PORT || 3000;

@Route("api/:version/users")
export class UserController {
  @Get("/")
  getUsers(req, res) {
    res.send("All users");
  }

  @Get("/:id")
  getUser(@Params() params, req, res) {
    res.send("Hello user " + params.id);
  }

  @Post("/")
  createUser(@Body() createUser, req, res) {
    res.send("User created" + createUser.name);
  }
}

app.use(express.json());

registerControllers(app, [UserController], {
  debug: true,
  vars: { version: "v1" },
});

app.listen(port, () => {
  console.log("⚡️[server]: Server is running at http://localhost:300");
});

Decorators

express-routing-controllers provides the following decorators for defining routes:

Routes

  • @Route(path: string): Specifies the base path for all routes defined within the controller.
  • @Get(path: string): Defines a GET route with the specified path.
  • @Post(path: string): Defines a POST route with the specified path.
  • @Delete(path: string): Defines a DELETE route with the specified path.
  • @Put(path: string): Defines a PUT route with the specified path.

Arguments

  • @Params(): Injects route parameters into the controller method.
  • @Body(): Injects the request body into the controller method.
  • @Query(): Injects the query into the controller method.

API Reference

registerControllers(app, controllers, options?) Registers the controllers with the Express application.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.

License

Express Controllers is MIT licensed.