Installations

npm install koa-joi-router-to-swagger-json

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

8.11.2

NPM Version

5.6.0 Score

71.1

Supply Chain

90.8

Quality

74.5

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

1

Unable to fetch Contributors

View all 1 contributors

Languages

1

JavaScript

JavaScript (100%)

Developer

zouyixiong

Download Statistics

Total Downloads

2,718

Last Day

1

Last Week

3

Last Month

7

Last Year

81

GitHub Statistics

1 Stars

36 Commits

1 Forks

2 Watching

1 Branches

1 Contributors

Bundle Size

40.57 kB

Minified

12.26 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

0.2.0

Package Id

koa-joi-router-to-swagger-json@0.2.0

Unpacked Size

72.39 kB

Size

22.41 kB

File Count

16

NPM Version

5.6.0

Node Version

8.11.2

Total Downloads

Cumulative downloads

Total Downloads

2,718

Last day

0%

1

Compared to previous day

Last week

200%

3

Compared to previous week

Last month

0%

7

Compared to previous month

Last year

-15.6%

81

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

3

lodash path-to-regexp z-joi-to-swagger

Dev Dependencies

5

eslint intelli-espower-loader koa-joi-router mocha power-assert

Versions

Koa-Joi-Router Docs Generator

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.

Preview

Install

1# use npm
2npm install koa-joi-router-to-swagger-json --save
3# use yarn
4yarn add koa-joi-router-to-swagger-json

Example

Visit example/ folder to see the full example.

API

new SwaggerAPI()

Creates a new SwaggerAPI instance.

swaggerAPI.addJoiRouter(router, options)

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:

prefix: Prefix to add to Swagger path (use prefix from JoiRouter if not set)

swaggerAPI.generateSpec(baseSpec, 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:

defaultResponses: Custom default responses

1{
2  200: {
3    description: 'Success'
4  }
5}

Donation

If you find this project useful, you can buy us a cup of coffee:

Acknowledgements

We are grateful to the authors of existing related projects for their ideas and collaboration:

Contributors


chuyik

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-02-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More