这是一个简便的 django app 将 swagger ui 搬到项目中展示。开发人员只需将 swagger 文档放到项目指定目录,即可打开相应的 URL 查看 swagger 文档,非常适合使用 Django 开发的项目,在开发过程同时编写文档,并同步更新到项目中,团队其他人员也可以同时看到最新修改的文档。
Django APP 为swaggerdoc
,像其他 APP 一样将该目录放到项目目录中。然后准备一些配置:
static
和templates
目录。DOC_DIR
, 存放 swagger 文档的目录。也可以不设置,默认为项目目录下的docs
文件夹。STATICFIELS_DIRS
,包含第 2 点的DOC_DIR
。如设置为os.path.join(BASE_DIR, 'docs')
,使得 Django 可以找到该目录下的 swagger 文档。url patterns
, 在项目的urls.py
文件设置 swagger 文档访问路径,包含swaggerdoc.urls
即可。如: url(r'^api/doc/', include('swaggerdoc.urls')
。这样,启动项目服务器,即可打开浏览器访问{服务其地址}/api/doc
就可以看到项目文档了。
效果图如下:
代码是一个完整的 django 工程,提供可运行的示例, 直接 git clone 试运行。