apiDoc: Skill: How to use apiDoc in Spring Boot

How to use apiDoc in Spring Boot

1. Install node.js

To check if node.js is successfully installed:

λ node --version
v10.15.0

2. After node.js installed, install apiDoc

npm install apidoc -g

To check if apiDoc is successfully installed:

λ apidoc -h
Usage: apidoc [options]

Options:
......

3. Set the apidoc configurations in apidoc.json

4. Write annotations above your functions in your project

5. Generate static api doc files

λ apidoc -i bdp\ -o bdp\src\main\webapp\apidoc