Create the documentation of your serverless functions automatically.
- Netlify Functions
- Vercel Functions
yarn add serverless-functions-api-docs
npm install serverless-functions-api-docs
Edit the file doc_config.js with the basic information of your site or organization.
For Next and Nuxt it is recommended to set the outputfile path to public and static folders.
const serverlessFunct = require('serverless-functions-api-docs/index'); const config = { basedir: "functions", outputfile: "index.html", info: { sitename: "MY SITE / ORGANIZATION", logourl: "MY LOGO URL", sitedescription: "MY SITE DESCRIPTION" } } serverlessFunct.createDoc(config);
Create an index.doc.json file inside each function folder.
project
β node_modules
β functions
| ββββfunction1
| β β index.js
| β β index.doc.json <-
| ...
β package.json
β doc_config.js
Each file must have the following structure:
[
{
"name": "ENDPOINT NAME",
"path": "/endpoint-url",
"method": "GET",
"description": "SOME DESCRIPTION",
"fields": [
{
"name": "name",
"type": "String",
"required": "true"
}
]
}
]
To generate the documentation we simply execute yarn run createdoc or npm run createdoc.
Look at the web generated in https://raulcr98.github.io/serverless-functions-api-docs/
Pull requests and π stars are always welcome. For major changes, please open an issue first to discuss what you would like to change.
Twitter @iamraul_net
Linkedin @iamraul