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

@trojs/openapi-server

v2.1.1

Published

OpenAPI Server

Downloads

2,195

Readme

OpenAPI server

NPM version Coverage Quality Gate Status Bugs Code Smells Technical Debt Vulnerabilities Maintainability Rating Reliability Rating Security Rating

Create easy a webserver API first with a OpenAPI spec.

Installation

npm install @trojs/openapi-server or yarn add @trojs/openapi-server

Test the package

npm run test or yarn test

How to use


const controllers = {
    // connect to a openationId in the OpenAPI spec with the same name
    getTest: ({
        context,
        request,
        response,
        parameters,
        specification,
        url
      }) => ({ //response an object
        test: 'ok'
    })
}

const { openAPISpecification, Api } = await openAPI({ file: './openapi-spec.json', base })
const api = new Api({
  version: 'v1',
  specification: openAPISpecification,
  controllers,
  logger: console,
  ajvOptions: { allErrors: true }
})
const { app } = await setupServer({
  env: process.env,
  apis: [api]
})

If you create a controller, you can easy connect it to the operationId in the OpenAPI spec. Check also the examples in the test files. In your controller you can use e.g. context, request and response, from express. It isn neccesary to define it in your controller, if you don't use it, you can remove it. e.g.

getTest: ({ parameters }) => 
    {
        return {
            test: 'ok'
        }
    }

parameters are query param's from the url of a get request, parsed by the type defined in the OpenAPI spec.

Specifications is the OpenAPI spec.

Url is the current url.

Add custom security handlers like JWT

import jwt from 'jsonwebtoken'

function jwtHandler(context, request, response) {
  const authHeader = context.request.headers.authorization;
  if (!authHeader) {
    throw new Error('Missing authorization header');
  }
  const token = authHeader.replace('Bearer ', '');
  return jwt.verify(token, 'secret');
}

const securityHandlers = [
  {
    name: 'jwt',
    handler: jwtHandler
  }
]

const api = new Api({
  version: 'v1',
  specification: openAPISpecification,
  controllers,
  securityHandlers
})

See also: https://openapistack.co/docs/openapi-backend/security-handlers/#security-handlers