Gathering detailed insights and metrics for fastify-swagger-ui
Installations
npm install fastify-swagger-uiDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
8.6.0
NPM Version
5.5.1
Score
73.4
Supply Chain
98
Quality
73.3
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Contributors
1
Download Statistics
Total Downloads
16,029
Last Day
2
Last Week
23
Last Month
494
Last Year
7,946
Bundle Size
252.85 kB
Minified
66.64 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
1.0.1
Package Id
fastify-swagger-ui@1.0.1
Size
3.71 MB
NPM Version
5.5.1
Node Version
8.6.0
Total Downloads
Cumulative downloads
Total Downloads
16,029
Last day
-50%
2
Compared to previous day
Last week
-83.2%
23
Compared to previous week
Last month
16.8%
494
Compared to previous month
Last year
51.2%
7,946
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
4
Dev Dependencies
5
Versions
Fastify Swagger UI Plugin
Acknowledgements
This project use and override the fastify-swagger plugin implementation for JSON documentation generation. My thanks for the Fastify team for the plugin.
Installation
npm install fastify-swagger-ui --save
Usage
const fastify = require('fastify')()
fastify.register(require('fastify-swagger-ui'), {
swagger: {
info: {
title: 'Test swagger',
description: 'testing the fastify swagger api',
version: '0.1.0'
},
host: 'localhost',
schemes: ['http'],
consumes: ['application/json'],
produces: ['application/json']
}
})
fastify.post('/some-route', {
schema: {
description: 'post some data',
tags: ['user', 'code'],
summary: 'qwerty',
payload: {
type: 'object',
properties: {
hello: { type: 'string' },
obj: {
type: 'object',
properties: {
some: { type: 'string' }
}
}
}
},
out: {
description: 'Succesful response',
code: 201,
type: 'object',
properties: {
hello: { type: 'string' }
}
}
}
}, (req, reply) => {})
fastify.ready(err => {
if (err) throw err
fastify.swagger()
})
For view the documentation need to go to: http://localhost[:port]/docs
Options
Calling fastify.swagger will return to you a JSON object representing your api, if you pass { yaml: true } to fastify.swagger, it will return you a yaml string.
By default this plugin exposes a /documentation route, you can change the path by passing the option { route: String } or { exposeRoute: false } if you do not need it.
#####example
{
swagger: {
url: '/docs', // By default use /docs, but you can change ir for other
info: {
title: 'Project Documentation',
description: 'Project Backend Documentation',
version: '1.0.0'
},
host: 'ip:port',
schemes: ['http'],
consumes: ['application/json'],
produces: ['application/json'],
excludes: ['/some-route'] // this param configuration is optional
}
}
For more information: https://github.com/fastify/fastify-swagger
Hide a route
Sometimes you may need to hide a certain route from the documentation, just pass { hide: true } to the schema object inside the route declaration.
Exclude routes
By default the route exclusions defined are: /documentation / and /*. If you want add other routes you can especify in the fastify.swagger options by passing for example: { excludes: ['/some-route'] }
Version
v1.0.0
Author
License
Licensed under MIT.
No vulnerabilities found.
No security vulnerabilities found.