DRF教程5-API接⼝⽂档和接⼝测试配置
配置好，就可以访问web页⾯
pip install coreapi
#安装依赖
from rest_framework.documentation import include_docs_urls
urlpatterns = [
....
path('docs/',include_docs_urls('xADM api docs'))
]
#配置url
class CourseViewSet(viewsets.ModelViewSet):
"""
retrieve:
返回指定course信息
list:
返回course列表
update:
更新course信息
destroy:
删除course记录
create:
创建course记录
partial_update:
更新部分字段
"""
#在view中的资源类下，说明注释信息
class Course(models.Model):
name = models.CharField(max_length=64,verbose_name='课程名称',help_text='课程名称')
...
#在model或者serializer中添加help_text字段。它会显⽰在api⽂档的字段描述信息中
命令⾏接⼝测试
以下所有信息，rest框架都在web api ⽂档接⼝中提供使⽤⽅法
pip install coreapi-cli
#安装命令⾏接⼝
(venv) E:\Python\xADM>coreapi get 127.0.0.1:8008/docs/
<xADM api docs "127.0.0.1:8008/docs/">
course: {
list()
create(name, desc, detail, degree, catalog, [learn_times], [students], [fav_num], [click_num])
read(id)
update(id, name, desc, detail, degree, catalog, [learn_times], [students], [fav_num], [click_num])
partial_update(id, [name], [desc], [detail], [learn_times], [degree], [students], [fav_num], [click_num], [catalog])        delete(id)
}
userprofile: {
list()
read(id)
}
#有哪些资源，每个资源提供什么action，⼀个action⾥要什么字段是必须写的，什么字段是可选的，都有说明。
coreapi action course list
#列出所有course资源
coreapi action course read -p id=1
#读取id=1的course资源
coreapi action course partial_update -p id=6 -p desc='win桌⾯运维⾼级班'
#部分更新id=6的course资源
影视资源站采集api接口数据

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。