jodacame / apidoc

API Rest Documentation Generator

Under development.

apidoc

API Rest Documentation Generator

Usage

Installation

npm install

mongoimport --db apidoc --collection settings --file settings.json

Runing

npm start

Runing with node

node index.js

Runing with nodemon

nodemon index.js

Open in your browser

http://localhost:8080

Donations

Please support our project

Paypal: https://www.paypal.me/jodacame

Bitcoin: 1CSmAD5jEhmNjJQ5HUtEHfRkJFtLJwnZc5

Ethereum: 0xf53B826a4c9FB18D4D2B33e8aa7e0A72b52952a0

apidoc's Issues

Home hero description

Write a professional text for hero section (Replace Lorem Lorem ipsum dolor sit amet ... Home Page)

Create a wizard install

• Email setting
• Mongo Setting
• Website setting

Update password

• Allow to change password (Required old password)
• Send email when change password process it's done

Recovery password

• Use the login form for recovery password (Email field)
• Send email with a new password and link for activation
• Validate activation link is not expired
• Add an animation when is sending an email

Add responsive design to every form element

Download module

• Customize colors
• Customize logo and title
• Allow download documentation to static files (HTML,CSS and JS)

Email template system

• Create a system template for all emails
• Recovery password
• Welcome
• Validation code

Complete home page design

• Features section
• Contact section
• Register motivation section

Register system

• Validating unique email
• Validation password length
• Send email with code verification
• Autologin to panel

Login system

• Validate Email
• Password
• verified status account

SignUp and Login text

Validate text into register and login modals

assets/templates/*

Validate account

• Validate account using a code sent by email
• Allow send again the code
• Disable all features to unverified accounts

Admin documentation

Folder organizations

• Create folder
• Edit folders
• Remove folders
• Make public folder
• Create endpoints

Endpoints

Form for make a documentation

• Url endpoint
• Title
• Type (GET,POST,DELETE,PUT)
• Description
• Params (name,type[GET,POST,HEADER],description,required)
• Response
• Allow edit,delete

Try system

• Allow try the endpoint