美文网首页Drf/Django开发记录
Drf官网教程(七) -文档

Drf官网教程(七) -文档

作者: dyq666 | 来源:发表于2018-06-24 01:15 被阅读22次

目录

  1. 配置文档
  2. 使用命令行工具

1. 配置文档

Schema类似一种自动生成url说明文档的功能

  • 安装

pip install coreapi

  • drf_tutorial/urls.py配置Schema
...
from rest_framework.schemas import get_schema_view

schema_view = get_schema_view(title='dyq_drf_tutorial')

urlpatterns = [
    ...
    url(r'^schema/$', schema_view)
]

可以在schema中配置一些参数,比如上面配置的title

  • 使用

访问http://127.0.0.1:8000/schema/即可。

2. 使用命令行工具

  • 安装

pip install coreapi-cli

  • 获取最简单的说明文档(个人认为这是最有用的功能)

coreapi get http://127.0.0.1:8000/schema/

相关文章

网友评论

    本文标题:Drf官网教程(七) -文档

    本文链接:https://www.haomeiwen.com/subject/qmqjyftx.html