1.0.4 • Published 9 months ago
docx-gen v1.0.4
Docx
Docx is a cli nodejs library for creating API documentation project.
Installation
Use the package manager npmjs to install docx.
npm install -g docx-gen
Usage
docx create --project MyDocs
# generate components
docx gen ComponentName
Options
Page title to use in the template
-pT or --title <pageTitle>
docx gen ComponentName -pT "Authorization"
docx gen ComponentName --title "Authorization"
Endpoint method to be used in the template
-m or --method <method>
docx gen ComponentName -m "POST"
docx gen ComponentName --method "POST"
Endpoint configuration to use
-e or --endpoint <endpoint>
docx gen ComponentName -e "https://api.docx-gen.com/v1/auth"
docx gen ComponentName --endpoint "https://api.docx-gen.com/v1/auth"
Notification
To consume the generated route, kindly update navigation component to handle click event.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.