python rest api 自动生成_Django Rest Framework 3.5 自动生成 API 文档

3.5新特性：

Docstrings on your API's views are now included in your schema's definition.

The helper method get_schema_view() has been added.

The schema generation code has been fully documented and outlined here.

Django Rest Framework 3.5 附带了get_schema_view方法，这个方法会为你的模式生成Django视图，它还允许我们传入一个Renderer(渲染器)类，渲染器将​​告诉视图应该如何渲染。举个例子：

from rest_framework.schemas import get_schema_view

from rest_framework.renderers import CoreJSONRenderer

schema_view = get_schema_view(

title='A Different API',

renderer_classes=[CoreJSONRenderer]

)

将会渲染你的api生成模式为JSON(具体来说，是遵循CoreAPI规范的JSON)

现在，使用django-rest-swagger中现成的渲染器，从我们的API生成swagger文档非常的简单。django-rest-swagger提供了两个有用的渲染器：SwaggerUIRenderer 和 OpenAPIRenderer。我们两个都用，因为SwaggerUIRenderer实际上使用渲染的OpenAPI格式。

让我们尝试下实现简单的api接口和自动生成文档：

bash/cmd 命令行操作

# 安装包并构建一个django项目，最后创建管理员

pip install Django

pip install djangorestframework

pip install django-rest-swagger

django-admin startproject api

cd api

python manage.py makemigrations

python manage.py migrate

python manage.py createsuperuser

api/settings.py 配置文件修改

# 在配置文件中修改两项设置

INSTALLED_APPS = [

# [django core apps]

... #