Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
koas-core
Advanced tools
Readme
Koa + OpenAPI Specification = Koas
Koas aims to make it easy to write a RESTful API based on Koa and an Open API V3 Specification.
This is the core package. For more details, see the mono repository README
npm install koa koas-core
const Koa = require('koa');
const { koas } = require('koas-core');
const document = {
openapi: '3.0.2',
info: {
title: 'My API',
version: '1.0.0',
},
paths: {
'/': {
get: {
responses: {},
},
},
},
};
const app = new Koa();
app.use(
koas(document, [
// Koas plugins go here.
]),
);
app.listen(3333);
Plugins are functions that take parameters provided by Koas, and return a Koa middleware. Typically, plugins are returned by a function, so options can be passed in.
Example plugin:
function myPlugin(options) {
return (document, resolveRef, runAlways, validate) => async (ctx, next) => {
await next();
};
}
module.exports = {
myPlugin,
};
TypeScript typings are provided. So it is also possible to write plugins using TypeScript. Pretty
much the only type annotation needed is Plugin
as the return option for the function.
import { Plugin } from 'koas-core';
export interface MyPluginOptions {
myOption: unknown;
}
export function myPlugin(options: MyPluginOptions): Plugin {
return (document, resolveRef, runAlways, validate) => async (ctx, next) => {
await next();
};
}
FAQs
> [Koa][] + [OpenAPI Specification][] = Koas
The npm package koas-core receives a total of 958 weekly downloads. As such, koas-core popularity was classified as not popular.
We found that koas-core demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.