
Product
A New Overview in our Dashboard
We redesigned Socket's first logged-in page to display rich and insightful visualizations about your repositories protected against supply chain threats.
ilabs-koa-joi-router-docs
Advanced tools
OpenAPI(aka Swagger) API docs generator for koa-joi-router.
This project is based on paul42/joi-router-swagger-docs.
A node module for generating Swagger 2.0 JSON definitions from existing koa-joi-router routes.
Aiming to be a replacement for koa-resourcer-docs which can take advantage of various Swagger 2.0 tools for generating client libraries, test suites, AWS Lambda/serverless, etc.
# use npm
npm install koa-joi-router-docs --save
# use yarn
yarn add koa-joi-router-docs
Visit example/ folder to see the full example.
Creates a new SwaggerAPI instance.
Add a joi-router instance to the API. The router should already have all its
routes set up before calling this method (which pulls the route definitions
from the router's .routes
property).
Options:
Create a Swagger specification for this API. A base specification should be
provided with an info
object (containing at least the title
and version
strings) and any other global descriptions.
Options:
{
200: {
description: 'Success'
}
}
If you find this project useful, you can buy us a cup of coffee:
We are grateful to the authors of existing related projects for their ideas and collaboration:
chuyik |
FAQs
OpenAPI(aka Swagger) API docs generator for koa-joi-router.
The npm package ilabs-koa-joi-router-docs receives a total of 803 weekly downloads. As such, ilabs-koa-joi-router-docs popularity was classified as not popular.
We found that ilabs-koa-joi-router-docs 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
We redesigned Socket's first logged-in page to display rich and insightful visualizations about your repositories protected against supply chain threats.
Product
Automatically fix and test dependency updates with socket fix—a new CLI tool that turns CVE alerts into safe, automated upgrades.
Security News
CISA denies CVE funding issues amid backlash over a new CVE foundation formed by board members, raising concerns about transparency and program governance.