1、安装依赖
pip3 install coreapi
2、在settings.py项目配置文件中:
# drf的配置,全局配置 REST_FRAMEWORK = { 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema', 'DEFAULT_AUTHENTICATION_CLASSES': [ # 自己写的认证类 'studentSystemt.apps.user.authen.MyJWTAuthentication' ], }
3、在项目总路由文件urls.py中:
from rest_framework.documentation import include_docs_urls
urlpatterns = [
...
path('docs/', include_docs_urls(title='站点页面标题', authentication_classes=[]))
]
#因为我们在项目中配置了自己的认证类。配上authentication_classes=[], 访问docs/路由时,无需走认证过程了。
4、在写视图类的时候,写上注释,
class Books():
"""
get:获取指定id的书籍信息,需要id
delete:删除指定id的书籍,需要id
patch:更新指定id的书籍,需要id和要更新的数据
"""
5、在models写模型类时写上help_text的注释。