ApiDoc

这篇文章总结一下apidoc项目的文档结构和细节内容。

1.apidoc的细节说明

1. docs目录为apidoc生成目录(除了apidoc.json、header.md、footer.md外，均为自动生成文档)
   

2. apidoc.json 为apidoc的主要配置文档，可以设置api文档页面的信息
   

3. header.md 可以设置api文档页面的header部分(此例中Introduction的部分)
   

4. footer.md 控制api文档页面的footer部分(此例中Best practices的部分)
   

5. apidoc/apps/modules/views.py 中的注释为 modules 的 API 注释

6. apidoc/apps/project/views.py 中的注释为 project 的 API 注释(详细的语法见 apidoc官网)
   
   
   
   
   

7. api文档的路径配置
   
   

8.自动生成api文档

cmd命令：apidoc -i [api注释代码所在的目录] -o [api文档的输出目录]

注意：每次重新自动生成api文档内容，需要先将docs中自动生成的文件（除了apidoc.json、header.md、footer.md外，均为自动生成文档）删除

2.运行

1. 浏览器打开网址：http://127.0.0.1:8000/docs/index.html