django-rest-framework教程6-如何⽣成DRF中的API接⼝⽂档（）1. 如何⽣成API接⼝⽂档
（1）settings.py⽂件中增加配置
REST_FRAMEWORK = {
# ⾃动⽣成API接⼝⽂档配置
"DEFAULT_SCHEMA_CLASS": "rest_framework.schemas.AutoSchema",
......,
}
（2）项⽬的根urls.py⽂件中增加配置
from rest_framework.schemas import get_schema_view
schema_view = get_schema_view(title="DRF API", description="简单描述")
urlpatterns = [
path('admin/', admin.site.urls),
path("schema/", schema_view),  # 接⼝⽂档
]
需使⽤JsonView格式显⽰，⾕歌浏览器需要安装插件JsonView插件，教程如下：
2. DRF的概要使⽤⽅法介绍
上⾯⽣成的drf api⽂档过于简单不好看，现在我们⽣成⼀个⾮常美观的API⽂档
先安装coreapi库：
pip install coreapi
（1）修改settings.py⽂件中的配置
REST_FRAMEWORK = {
# ⾃动⽣成API接⼝⽂档配置
"DEFAULT_SCHEMA_CLASS": "rest_api.AutoSchema",
......,
}
（2）修改项⽬的根urls.py⽂件中的配置
from rest_framework.documentation import include_docs_urls
urlpatterns = [
path('admin/', admin.site.urls),
path("docs/", include_docs_urls(title="DRF API⽂档", description="django-rest-framework快速⼊门")),
]
（3）效果如下：
（4）如果想在description中增加具体的中⽂描述信息，那么我们可以在定义的模型类中增加⼀个选项：help_text="xxx"即可显⽰
django怎么学（5） 我们定义的类视图只有继承⾃APIView或它的⼦类，才会⾃动⽣成接⼝⽂档，如果是继承⾃Django⾃带的View或函数视图是不会⾃动⽣成接⼝⽂档的。
注意： retrieve⾏为⽣成接⼝⽂档后叫：read
（6） 每个⾏为下⾯如果想增加⼀个对该⾏为的描述，可以这样写
class BookViewSet(viewsets.ModelViewSet):
"""
list:
返回图书列表信息
retrieve:
返回⼀本书的详情信息
create:
新增⼀本图书
update:
更新⼀本图书
delete:
删除⼀本图书
"""
queryset = BookInfo.objects.all()
serializer_class = BookInfoSerializer
最终API⽂档结果就是这样了：

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