系統：ubuntu18.04 x64

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

安裝

pip install django==2.1.5
pip install djangorestframework # rest api
pip 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 models

class 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 admin
from apiApp.models import Test
# Register your models here.

@admin.register(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:09
Django 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 serializers
from apiApp.models import Test

class TestSerializers(serializers.ModelSerializer):
 class Meta:
  model = Test # 指定的模型類
  fields = ('pk','name','sex','age',) # 需要序列化的屬性

修改/api/views.py，檢視

from django.shortcuts import render
from rest_framework import viewsets
from apiApp.models import Test
from apiApp.serializers import TestSerializers


class TestViewSet(viewsets.ModelViewSet):
 # 指定結果集並設定排序
 queryset = Test.objects.all().order_by('-pk')
 # 指定序列化的類
 serializer_class = TestSerializers

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

from django.contrib import admin
from django.urls import path,include

urlpatterns = [
 path('admin/',admin.site.urls),path('',include('apiApp.urls')),# 新增應用的路由地址
]

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

from django.conf.urls import include
from django.urls import path
from rest_framework import routers
from apiApp import views
from rest_framework.documentation import include_docs_urls

API_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資料操作就是小編分享給大家的全部內容了，希望能給大家一個參考，也希望大家多多支援我們。