Restframework從入門到精通(六):Restframework之編寫API檔案
阿新 • • 發佈:2019-12-31
概要檔案
Restframework
有一個顯示概要檔案的功能,根據檔案顯示
根據檔案的說明,我就直接修改路由了
urls.py
from django.conf.urls import url,include
from django.contrib import admin
from Book.views import *
from rest_framework.routers import DefaultRouter
from rest_framework.schemas import get_schema_view
router = DefaultRouter()
router.register(r'Book' ,BookViewSet)
router.register(r'Publish',PublishViewSet)
schema_view = get_schema_view(title='Pastebin API')
urlpatterns = [
url(r'^admin/',admin.site.urls),url(r'^',include(router.urls)),url('^schema/$',schema_view),]
複製程式碼
根據檔案的說明,直接執行是可以的,但是我這裡還是出了一些問題,比如:
這個問題谷歌搜尋後的最佳答案是這樣的
emmm......雖然說知道了這個是什麼原因也沒啥用,我們直接升級一下Django
Restframework
的版本就好了,新一點的版本沒有這個bug
比如Django2.0
和Restframework3.7.7
及以上的版本不會出現這個問題
我更新了下版本,按照原來的配置,是可以執行的,如圖概要檔案已經生成
API檔案
Restframework
自帶一個API
總和的說明檔案,我們只需匯入一個包和配置路由就可以直接使用
urls.py
......
from rest_framework.documentation import include_docs_urls
......
urlpatterns = [
url(r'^docs/',include_docs_urls(title="圖書管理系統" )),......
複製程式碼
然後我們直接訪問 http://127.0.0.1:8000/docs/ 就可以看到我們的檔案已經做好了