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

koas3

v0.4.0

Published

## Required peer dependencies

Downloads

74

Readme

OpenAPI v3 implementation for koa

Required peer dependencies

  • @koa/cors
  • @koa/router
  • js-yaml
  • koa
  • koa-body
  • koa-send
  • koas3

npm i @koa/cors @koa/router js-yaml koa koa-body koa-send koas3

Usage example

const fs = require("fs");
const jsyaml = require("js-yaml");
const Koa = require("koa");
const KOAS3 = require("koas3").default;
const http = require("http");
const URL = require("url");

const createApp = async (openapiPath, options) => {
  // create openapi object
  const openapiFile = fs.readFileSync(openapiPath, "utf8");
  const openapi = jsyaml.safeLoad(openapiFile);

  // create Koa app
  const app = new Koa();

  // optionally setup app as proxy
  app.proxy = true;

  // optionaly use default error handler
  app.use(async (ctx, next) => {
    try {
      await next();
      if ([404, 405].includes(ctx.status)) {
        ctx.throw(ctx.status, `Path ${ctx.path} not found`);
      }
    } catch (err) {
      // example of error handling
      if (err.message === "RequestValidationError") {
        const { status, name, message, ...payload } = err;
        ctx.status = typeof err.status === "number" ? err.status : 500;
        ctx.body = {
          statusCode: ctx.status,
          name: "INVALID_SCHEMA",
          description: err.message,
          payload,
        };
      } else {
        // application
        ctx.app.emit("error", err, ctx);
        ctx.status = typeof err.status === "number" ? err.status : 500;
        ctx.body = {
          statusCode: ctx.status,
          name: err.name,
          description: err.message,
          payload: { error: err.message, stack: err.stack, originalError: err },
        };
      }
    }
  });

  // koas3 openapi magic
  const router = await KOAS3(openapi, options);

  // this is important - setup router prefix based on openapi servers
  // depends on your app logic, this just takes the first
  if (openapi.servers && openapi.servers.length) {
    const [serverDefinition] = openapi.servers;
    const url = URL.parse(serverDefinition.url);
    let routePrefix = url.pathname.replace(/\/$/, "") + "/";
    if (serverDefinition.variables) {
      Object.keys(serverDefinition.variables).forEach((k) => {
        routePrefix = routePrefix.replace(
          new RegExp(`{${k}}`, "g"),
          serverDefinition.variables[k].default
        );
      });
    }

    router.prefix(routePrefix);
  }

  // resup KOAS3 router to the app
  app.use(router.routes());
  app.use(router.allowedMethods());

  app.on("error", (err) => {
    // this is any other error handler
    console.error("AppError:", err);
  });

  return app;
};

// run the server
createApp("./openapi.yaml", {
  controllersPath: "./controllers",
})
  .then(async (app) => {
    // make optional database connections

    //mongo.connector(Object.assign({ connect: false }, config.get('mongodb')));
    //await mongo.setup(dbSetup);

    http
      .createServer(app.callback())
      .listen({ port: 9000 }, () => {
        console.log("API is listening on port 9000");
      })
      .on("error", (e) => {
        console.error(`Error starting server: ${e}`);
      });
  })
  .catch(async (e) => {
    console.error("ApiError:", e);
    // stop database connections

    //await mongo.close();
  });