概要是一种机器可读的文档,用于描述可用的API,其URLS,以及它们支持的操作。 概要可用于自动生成文档,也可以用于驱动可与API进行交互的动态客户端库。

一、Core API

为了提供概要支持,REST框架引用了Core API规范。

Core API是用于描述API的文档规范。它用于提供API的内部表示形式和交互方式。可同时用于服 务器端或客户端。

当在服务器端使用时,Core API支持以各种模式或超媒体格式呈现。 当在客户端使用时,Core API允许动态驱动的客户端库与任何公开支持的模式或超媒体格式的API交互。

二、添加概要

REST框架支持明确定义的概要视图,也可以自动生成概要。由于教程走到这里,我们使用的是 视图集和路由器,所以可以简单地使用自动生成概要的方式。

我们需要安装 coreapi python包才能生成API概要,还需要安装pyyaml库,渲染概要,使之成 为通用的基于YAML格式的OpenAPI 。

pip install coreapi pyyaml

现在我们可以通过在URL配置中包含一个自动生成的概要视图来为API添加概要。

在根路由urls.py下,灵活地插入下面的代码:

from rest_framework.schemas import get_schema_view
schema_view = get_schema_view(title='Test API')
urlpatterns = [
    path('schema/', schema_view),
    ...
]

重启服务器,在浏览器中访问http://127.0.0.1:8000/schema/,可以看到corejson成为可用选项之一。

image-20210120131928814

我们也可以通过在 Accept 标头中指定所需的内容类型从命令行请求概要。

最后


DRF的快速入门教程到这里就结束了。

本教程源代码地址:

本文作者:博主:
文章标题:DRF-快速入门--概要和coreapi
本文地址:https://wouldmissyou.com/archives/46/     
版权说明:若无注明,本文皆为“多点部落”原创,转载请保留文章出处。
最后修改:2021 年 01 月 20 日 01 : 35 PM
如果觉得我的文章对你有用,请随意赞赏