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

@brdu/express-swagger

v1.3.7

Published

Express middleware handles routing, request validation and standardized responses based on Swagger (OAS 2) YAML specification file

Downloads

7

Readme

This Express middleware accepts a Swagger (OAS2) specification file for input and maps all routes found in the document to your server.

The built-in validator method verifies required headers and validates request bodies against schemas found in the Swagger file.

The emiter method is responsible for returning standardized responses as outlined in Swagger specifications, making it easier to enforce consistency in your API responses.

Usage

server.js

const express = require('express')
const path = require('path')

const { routes, validator } = require('@brdu/express-swagger')({
  swaggerPath: path.resolve(__dirname, './config/swagger-mock.yaml'),
  controllersPath: path.resolve(__dirname, './controllers'),
}) /* Initialize middleware; initialization schema

  type: object
  required:
    - swaggerPath
    - controllersPath
  properties:
    swaggerPath:
      type: string
      description: >-
        Path your API Specification in Swagger (OAS2) YAML
    controllersPath:
      type: string
      description: >-
        Path to your API Controllers
    fileNameCasing:
      type: string
      enum:
        - KEBAB
        - CAMEL
        - SNAKE
      default: KEBAB
      description: >-
        Casing convention used in your directories and files
*/

const app = express()
app.use(express.json())
app.use(express.urlencoded({ extended: true }))

/*
  Create server routes found in your API Specifications
  It's based on the 'routes' array; generated when the middleware is initialized
  The request passes through the validator, before reaching the associated controller
*/
routes.map(({
  fullPath,
  method,
  controller,
  parameters,
  responses,
}) => app[method](
  fullPath,
  (req, res, next) => validator(req, res, next, parameters, responses),
  controller,
))

const port = process.env.PORT || 8080
app.listen(port, () => {
  console.log('app listening on port', port)
})

controllers/getResourceById.js

module.exports = (req, res) => {
  /*
    The validator middleware injects the emiter method into the res object
    Use to return standardized responses, adherent to your specifications
  */
  return res.emiter({
    res,
    code: 200,
    data: {
      // any data returned from your database or other services
    },
  })
}