dokuinjs
It lets you make documentation for your Program easier. New to dokuInjs ? Take a look Tutorial and Guide
Table of Content
- Installation
- Usage
- Example
Instalation
Make sure you have npm installed. Then install dokuinjs to be used in your project with command
npm install dokuinjsUsage
-
you should run dokuinjs in your terminal with command
dokuin init-
input about your project
Projct's name :
Project's Description :
Base URL :
Author's name :-
run dokuinjs with command
dokuin create-
input your endpoints
you can put your endpoints as many as you want
HTTP method:
Headers (yes/no) :
QueryParams (yes/no) :
Body (yes/no) :-
now run dokuinjs to get all responses from your endpoints
dokuin run-
and finally convert your responses to md file
dokuin convertvoila your documentation is ready !
Example
-
Instal and make config file from dokuinjs
npm i dokuinjs
What's your project's name ? Entertainme
What's the author's name ? Meggy-
input your endpoints with command
1. Example
dokuin create
your endpoints
HTTP method : get
Path:
Headers (yes/no) : yes
key: token
value : dok23uin42js52ist52di32e78be67ste
Add more Headers (yes/no) : no
QueryParams (yes/no) : yes
key : id
value : w8974e89is0oo
add more params (yes/no) : no
Add more endpoints (yes/no) : no
2. Example
dokuinjs create
your endpoints
HTTP method : put
Path: movies/
Headers (yes/no) : yes
key: token
value : dok23uin42js52ist52di32e78be67ste
Add more Headers (yes/no) : no
QueryParams (yes/no) : yes
key : movieId
value : w8974e89is0oo
add more params (yes/no) : no
Body (yes/no) : yes
key : title
value : dark
add more Query (yes/no) : yes
key : genre
value : adventure
add more Query (yes/no) : yes
key : popularity
value : 34.912
add more Query (yes/no) : no
Add more endpoints (yes/no) : no
-
with this command dokuinjs will run all your endpoints
dokuin run-
and now you can get your md documentation from your respose
dokuin convert
