Python-Django使用apidoc接口文档

最近工作中有用到apidoc,感觉很方便,记录一下...

都是链接地址,比较懒...

1)参照:安装apidoc

2)将docs文件夹(包括apidoc.json和header.md)拷贝到自己方便的位置,没有的话就创建两个文件,比如我的就是放在了static静态文件夹下

Python-Django使用apidoc接口文档_第1张图片

3)按照要求书写接口文档,参照:使用apidoc 生成Restful web Api文档

4)在docs文件夹下面执行命令: apidoc -i  '要生成的文档所在地址'  -o  输出位置

比如我的目录结构如下:

假如书写的接口文档在apps里面,那么生成命令就是:

apidoc -i ../../apps/ -o ../static/

注意(Bug):如果生成后再次生成,终端生成成功但是页面还是原来的页面,可以将下图中红色框中文件删除,重新生成

Python-Django使用apidoc接口文档_第2张图片

生成后,会自动在static文件夹下面生成apidoc文件夹,如图:

Python-Django使用apidoc接口文档_第3张图片

5)访问接口文档,

①settings设置apidoc_url

APIDOC_ROOT = os.path.join(STATIC_ROOT, 'apidoc')

②url路由

from django.urls import path, include, re_path
from django.views.static import serve
from django.conf import settings
urlpatterns = [
    re_path(r'^apidoc/(?P.*)$', serve, {'document_root': settings.APIDOC_ROOT}),
]

注意:这样手机静态文件是自己自定义手机django的静态文件,需要把django自动收集静态文件关闭的,如下图:

Python-Django使用apidoc接口文档_第4张图片

然后启动django项目,输入:IP:Port/static/apidoc/index.html

就会访问写好的接口文档.

最后上一张效果图:

Python-Django使用apidoc接口文档_第5张图片

Over,,,

 

你可能感兴趣的:(Python-Django使用apidoc接口文档)