clout-swagger
API documentation generation using the OpenAPI Specification
Install
In the directory of your clout-js application, do the following;
-
Install this package
npm install clout-swagger --save
-
Add this module to
package.json{ ... "modules": ["clout-swagger"] ... }
Configure
Create a new file swagger.default.js or swagger.<YOUR_ENV>.js in /conf directory with the following JavaScript.
module.exports = {
swagger: {
enabled: true,
basePath: '/docs',
info: {
termsOfService: '<url-here>',
contact: {
email: 'youremail@org.tld'
},
license: {
name: 'Apache 2.0',
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
},
},
tags: [
{
name: 'clout',
description: 'clout-js docs',
externalDocs: {
description: 'find out more',
url: 'http://docs.clout.tech'
}
}
]
}
};Usage
The documentation will be derived by your clout-api's
Defining API parameters
You can now define information regarding your API params using the (OpenAPI standard)[https://swagger.io/docs/specification/describing-parameters/].
Using the definitions in the above link, an example api would look like the following.
module.exports = {
login: {
path: '/auth/login',
methods: ['post'],
params: {
read: {
in: 'body',
required: true,
schema: {
type: 'string'
}
},
write: {
in: 'body',
required: true,
schema: {
type: 'string'
}
}
}
}
};