Installations

npm install koa2-swagger-ui

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

22.11.0

NPM Version

10.9.0 Pull Requests

Open

0

Total

196

Closed

60

Merged

136

Issues

Open

8

Total

36

Closed

28

Releases

74

v5.11.0

Published on 18 Nov 2024

v5.10.0

Published on 06 Nov 2023

v5.9.1

Published on 02 Oct 2023

v5.9.0

Published on 23 Aug 2023

v5.8.0

Published on 15 May 2023

v5.7.0

Published on 18 Jan 2023

View all 74 releases

Contributors

2

Unable to fetch Contributors

View all 2 contributors

Languages

2

TypeScript

Handlebars

TypeScript (57.07%)

Handlebars (42.93%)

Developer

scttcper

Download Statistics

Total Downloads

5,701,110

Last Day

8,364

Last Week

33,394

Last Month

150,613

Last Year

1,887,558

GitHub Statistics

106 Stars

359 Commits

32 Forks

5 Watching

3 Branches

2 Contributors

Bundle Size

238.81 kB

Minified

77.60 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

5.11.0

Package Id

koa2-swagger-ui@5.11.0

Unpacked Size

20.96 kB

Size

7.79 kB

File Count

8

NPM Version

10.9.0

Node Version

22.11.0

Publised On

18 Nov 2024

Total Downloads

Cumulative downloads

Total Downloads

5,701,110

Last day

10.2%

8,364

Compared to previous day

Last week

-14.7%

33,394

Compared to previous week

Last month

1%

150,613

Compared to previous month

Last year

31%

1,887,558

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

3

handlebars lodash read-pkg-up

Peer Dependencies

1

@types/koa

Dev Dependencies

14

@ctrl/eslint-config @types/koa @types/koa-router @types/lodash @types/node @types/supertest @vitest/coverage-v8 koa koa-router supertest swagger-ui-dist ts-node typescript vitest

Versions

koa2-swagger-ui

Host swagger ui at a given directory from your koa v2 app

Inspired by:

swagger-injector for serving on a specific route
hapi-swaggered-ui for serving files from node_modules using a handlebars driven index.html

install

npm install koa2-swagger-ui --save

config

for more swaggerOptions see swagger-ui defaults:

1title: 'swagger', // page title
2oauthOptions: {}, // passed to initOAuth
3swaggerOptions: { // passed to SwaggerUi()
4  dom_id: 'swagger-ui-container',
5  url: 'http://petstore.swagger.io/v2/swagger.json', // link to swagger.json
6  supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
7  docExpansion: 'none',
8  jsonEditor: false,
9  defaultModelRendering: 'schema',
10  showRequestHeaders: false,
11  swaggerVersion: 'x.x.x' // read from package.json,
12  validatorUrl: null, // disable swagger-ui validator
13},
14routePrefix: '/docs', // route where the view is returned
15specPrefix: '/docs/spec', // route where the spec is returned
16exposeSpec: false, // expose spec file
17hideTopbar: false, // hide swagger top bar
18favicon: '/favicon.png', // default favicon
19customCSS: `h1 { color: red }`, // Add Custom CSS on the html

example

1import Koa from 'koa';
2import { koaSwagger } from 'koa2-swagger-ui';
3
4const app = new Koa();
5
6app.use(
7  koaSwagger({
8    routePrefix: '/swagger', // host at /swagger instead of default /docs
9    swaggerOptions: {
10      url: 'http://petstore.swagger.io/v2/swagger.json', // example path to json
11    },
12  }),
13);
14
15app.listen(3000);

example with koa-router and yaml source

depends on yamljs to turn your Yaml into a JS object

npm install --save yamljs

1const Koa = require('koa');
2const Router = require('koa-router');
3const yamljs = require('yamljs');
4const koaSwagger = require('koa2-swagger-ui');
5
6const router = new Router({ prefix: '/' });
7
8const app = new Koa();
9const router = new Router();
10
11// .load loads file from root.
12const spec = yamljs.load('./openapi.yaml');
13
14// example 1 using router.use()
15router.use(koaSwagger({ swaggerOptions: { spec } }));
16
17// example 2 using more explicit .get()
18router.get('/docs', koaSwagger({ routePrefix: false, swaggerOptions: { spec } }));
19
20app.use(router.routes());
21app.listen(3000);

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

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

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

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

SAST

Determines if the project uses static code analysis.

Score

3.8

/10

Last Scanned on 2025-01-27

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

koa2-swagger-ui

Installations

Developer Guide

Yes

CommonJS

22.11.0

10.9.0

Pull Requests

0

196

60

136

Issues

8

36

28

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

scttcper

Download Statistics

GitHub Statistics

Bundle Size

238.81 kB

77.60 kB

Maintainers

Package Meta Information

Total Downloads

5,701,110

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

koa2-swagger-ui

install

config

example

example with koa-router and yaml source

10

10

10

10

8

2

0

0

0

0

0

0

0

0

3.8

/10

Other packages similar to koa2-swagger-ui