Talking about the use of apidoc

Use the premise: the server has been installed apidoc

1. Project root directory of the establishment of apidoc.json, file basic information is as follows

{ 
  "Name": "Project Name", 
  "Version": "This is a good version", 
  "the Description": "Project Document Interface" 
}

2. The comments in the code strictly according to the rules apidoc

Examples of the official     search

3. Run the command to generate the interface documentation

apidoc -i ../api/ -o ./apidoc/ 
command interpreter: 
the latter is required -i parameter generating module interface document relative path to the current file (apidoc.json) in 
-o parameter is generated behind the interface document files stored in folders, no need to change

4. Access interface documentation generated

Domain Name / apidoc