DokuNEXT is simple documentation generator for Postman (currently only supports Postman v2.1 API) that can simpli you use for viewing API Documentation, offline or deployed on hosting.
You can see the demo here -> https://dokunext.vercel.app/.
Just open up and fill the authorization token with dokunext and you are ready to go
-
To start you have to clone this repo.
git clone https://github.com/azvyae/dokunext
-
Update your
.gitignorefile to allowjson/postman/collections/*andjson/postman/environments/*folder being updated to for git. -
Export Postman v2.1 collection json file and put it to
json/postman/collectionsfolder. You may also want to export environments and put it tojson/postman/environments/*folder. -
Add
.envfile to root of your project providingSECRET_TOKENkey and its value. You can also provideSECRET_TOKENenvironment variable to your hosting. -
Build, and voila!
npm run build
- API Documentation Generator with markdown support, definition files supported are:
- Postman v2.1
- Organized folder table of contents and anchor links to each API requests
- Support multiple collections and environments
- Has simple authorization by providing simple token
- Examples! It can show multiple examples and its returned response code, code example supported are:
- cURL
- Copy paste code easy
- Responsive UI
- Next.js Documentation - learn about Next.js features and API.
- Zustand Documentation - learn about Zustand.
- React Markdown Documentation - learn about react-markdown library.
- Typescript Documentation - learn Typescript.
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.
Feel free to open issues and pull requests.
Future plan:
- Organize better
- Allow support on OpenAPI file definitions
- Improve UI