系統：ubuntu18.04 x64

GitHub：https://github.com/xingjidemimi/DjangoAPI.git

安裝

pip install django==2.1.5pip install djangorestframework # rest apipip install coreapi pygments markdown # 自動化接口文檔

API示例

創建django項目

django-admin startproject DjangoAPI

創建應用

cd DjangoAPI

python manage.py startapp apiApp

項目代碼

修改settings.py，添加應用到配置中

INSTALLED_APPS = [ ’django.contrib.admin’, ’django.contrib.auth’, ’django.contrib.contenttypes’, ’django.contrib.sessions’, ’django.contrib.messages’, ’django.contrib.staticfiles’, ’rest_framework’, # 添加rest_framework應用 ’apiApp’, # 添加apiApp應用]

執行數據庫遷移

python manage.py migrate

創建管理員，會提示輸入用戶名：ubuntu，郵箱：[email protected]，密碼：ubuntu123456

python manage.py createsuperuser

修改/api/models.py，創建數據庫模型。

from django.db import modelsclass Test(models.Model): name = models.CharField(u’姓名’, max_length=100, default=’no_name’) sex = models.CharField(u’性別’, max_length=10, default=’male’) age = models.CharField(u’年齡’, max_length=3, default=’0’) def __unicode__(self): return ’%d: %s’ % (self.pk, self.name)

創建模型后執行：

python manage.py makemigrations # 生成數據庫遷移文件

python manage.py migrate # 執行數據庫遷移

修改/api/admin.py，寫后臺管理代碼

from django.contrib import adminfrom apiApp.models import Test# Register your models [email protected](Test)class BlogTypeAdmin(admin.ModelAdmin): list_display = (’pk’, ’name’) # 在后臺列表下顯示的字段

運行項目

python manage.py runserver

出現如下內容表明成功：

System check identified no issues (0 silenced).January 23, 2019 - 08:28:09Django version 2.1.5, using settings ’DjangoAPI.settings’Starting development server at http://127.0.0.1:8000/Quit the server with CONTROL-C.

瀏覽器輸入：

http://127.0.0.1:8000/ # 出現django成功的界面

http://127.0.0.1:8000/admin # 進入管理后臺

序列化模型類，在/api/下創建serializers.py，返回json數據

from rest_framework import serializersfrom apiApp.models import Testclass TestSerializers(serializers.ModelSerializer): class Meta: model = Test # 指定的模型類 fields = (’pk’, ’name’, ’sex’, ’age’,) # 需要序列化的屬性

修改/api/views.py，視圖

from django.shortcuts import renderfrom rest_framework import viewsetsfrom apiApp.models import Testfrom apiApp.serializers import TestSerializersclass TestViewSet(viewsets.ModelViewSet): # 指定結果集并設置排序 queryset = Test.objects.all().order_by(’-pk’) # 指定序列化的類 serializer_class = TestSerializers

修改/urls.py/，配置主路由

from django.contrib import adminfrom django.urls import path, includeurlpatterns = [ path(’admin/’, admin.site.urls), path(’’, include(’apiApp.urls’)), # 添加應用的路由地址]

在/api/下創建urls.py，配置應用路由

from django.conf.urls import includefrom django.urls import pathfrom rest_framework import routersfrom apiApp import viewsfrom rest_framework.documentation import include_docs_urlsAPI_TITLE = ’API Documents’API_DESCRIPTION = ’API Information’# 定義路由地址route = routers.DefaultRouter()# 注冊新的路由地址route.register(r’test’, views.TestViewSet)# 注冊上一級的路由地址并添加urlpatterns = [ path(’’, include(route.urls)), # 接口文檔路由 path(r’docs/’, include_docs_urls(title=API_TITLE, description=API_DESCRIPTION, authentication_classes=[], permission_classes=[]))]

運行項目

python manage.py runserver

打開瀏覽器輸入：

http://127.0.0.1:8000 # api主頁

點擊主頁提供的鏈接http://127.0.0.1:8000/test進入下一級目錄

http://127.0.0.1:8000/docs進入接口文檔

使用Postman測試工具測試api數據

進入ubuntusoftware應用商店，搜索postman進行安裝

在postman中輸入http://127.0.0.1:8000/api/student點擊send，并返回json數據。

以上這篇Django+RestFramework API接口及接口文檔并返回json數據操作就是小編分享給大家的全部內容了，希望能給大家一個參考，也希望大家多多支持好吧啦網。