教主技術進化論 2024年第29期.Django_DRF_RestAPI實戰

现任明教教主
1粉絲
23 次觀看·2024年12月18日
教主技術進化論 2024年第29期.Django_DRF_RestAPI實戰
歡迎來到2024年的倒數第29期教主技術進化論
好吧
我們講什麼呢
我們來講Jungle的REST API的實戰
用它一個叫DRF
叫DRF
其實就是Jungle的REST Fanwork
這麼一個REST API的這麼一個框架
好吧
那麼這期進化論呢
是我的一個學員的點菜
他點了很久了
那麼開始呢
我一直沒覺得這個特別重要
但是現在呢
我覺得還是比較有重要的
因爲我很多項目都是來Jungle開發的
我有兩個內部系統
其實呢
嗯
其實呢
以前就說我們需要特別是現在的OpenAI
那麼我有一個AI機器人
然後呢
想去讀取這些內部系統的一些數據
那麼我需要單獨給他寫一些程序啊
一些View
然後呢
讓我OpenAI去讀
那麼就能不能夠一把說
就是能不能夠把我內部系統的那個數據庫一把說出來
然後直接提供一個這個REST API
然後呢
甚至呢
幫我把這個文檔
在線文檔都幫我做好
我想想其實確實對我而言還是比較有需求的
就說呢
能夠通過這個技術
直接把我的數據庫直接變成REST API對外開放
然後呢
我們做認證
首先給他做令牌的認證
還能夠給他出一個Open API的這麼一個文檔
OK
這樣的話
便於別人也能夠好用
而且呢
又整合了Django的內部的權限的控制
我可以去控制哪些用戶可以去做數據庫的什麼樣的操作
想想還是很不錯的
OK
首先呢
一把說能把你的所有的這個數據庫通過REST API發佈出來
能夠增加一個這個Token認證
然後呢
我這兒也有HTTPS
然後呢
跟Django的內部認證進行整合
然後呢
你可以設置用戶
然後呢
可以對這個數據庫的讀寫權限進行控制
想想還是不錯的
好吧
過兩天我可以考慮把我們公司內部的這個也這麼發佈出來
然後呢
這樣的話
用我的Open AI
那麼去調用他的API
然後呢
就能夠更好地去查一下學員的狀況啊
這個比如說今天有沒有上課呀
今天上課鏈接什麼呀
我覺得還是不錯的
好吧
我用完之後感覺效果還不錯
而且通過這個呢
也把一些
這次呢
也重新做了一個封裝
我們問了這個GDP一個最新的最好的一個封裝的實踐
如何給他封裝HTTPS
是一個新的封裝方案
以前呢
用的是UWSGI加Nginx
那麼感覺性能不好
那麼現在呢
用一種新的異步的封裝
因爲現在呢
也支持ASGI了
然後呢
一種新的異步封裝性能也會更好一些
所以這次呢
我在很多細節上呢
做了一些探索
好吧
OK
而且順便
我覺得通過這個課也可以再給他講講REST API
因爲我是自己開發了一個
相當於我自己開發了一個REST API的一個server
然後呢
我也做了REST API的一些測試
就是這些
就是server
然後呢
我也給他做一些測試
然後呢
順便也給他講一下REST API是什麼
然後呢
爲什麼要這麼做
我覺得還是不錯的
做一個精華論還是非常有教育意義的
好吧
那麼項目呢
整個項目被送到了內部的我的PYK的Lab
你們可以去搞定它
下載它
好吧
內部學員可以下載啊
好
那麼這是他的這個框架的網頁
其實我也沒看
好吧
整個過程用那個O1 Pro來做的非常的穩定
雖然說價格1500一個月
但是我覺得非常的穩
那他出的代碼幾乎沒有bug
好吧
可能不滿足要求
不滿足要求再聊
好吧
但是我覺得出bug的可能性很小
因爲我的一些需求其實都很特殊
出bug的幾率有
以前用SO的話
我覺得經常出bug
而且會出現一個循環的bug
他一直解決跳不出來
好吧
但是我覺得O1 Pro非常的穩
非常的穩
好吧
基本上出的代碼都是能夠一把過的
只是可能沒有滿足你的要求
然後你把信息再反覆提供給他多聊幾遍
基本上就沒問題了
好吧
代碼大部分都是由O1 Pro出的
但是整個過程是我指導的
好吧
現在基本上代碼就不用管了
代碼就是他來出
但是我來調細節
我來提要求
好吧
基本上時長整個花了兩個小時左右
然後從無到有
包含最後的API的架設
然後API的測試
然後最後的Docker的封裝
其實封裝花了很多時間
就是Docker的封裝
其實花了很多時間
前期的代碼還是比較簡單的
後面封裝的時候
遇到了一些困難
那麼各種各樣的困難
好吧
差不多用了兩個小時
最終全部搞定
好吧
好
說一下REST API
我經常給學生說
REST API其實就是一種私有的
只要你說REST API
就是這個廠商私有搞出來的API
REST只是一種方法論
我覺得正經的方法論
好吧
那麼REST首先他缺少一個主語
他的主語叫支援
就缺少主語
沒有主語
那麼如果只是翻譯REST的話
叫表現層狀態轉換
那麼加上主語的話
叫做支援狀態層狀態轉換
好
首先什麼叫支援
怎麼定位一個支援
就通過一個UIL
我們就可以來定位一個支援
一個鏈接
一個UIL
就能定位一個支援
這個支援可能是一個圖片
可以是一個音樂
可以是一種服務
等等
好吧
通過一個UIL就能夠定位一個支援
好吧
這是一個
這是支援
通過UIL來定位
OK
那麼我們可以看一下
順便我們可以看看
比如說我先講講理論
UIL
這個時候
我們通過這個UIL
通過這個UIL
我們就定位了一個
可以認爲是一個文章
OK
一個文章
當然我就爲了演示
所以數據庫很簡單
就是一個非常簡單的
這麼一個數據庫
一個文章
然後它的title和它的內容
這個東西很簡單
當然你可以有其他的數據庫
我這個數據庫
就是爲了用來演示的
好吧
OK
通過一個UIL
我們可以去定位它
去定位它
OK
那麼這樣的話
就可以訪問一個文章的
這麼一個支援
好吧
OK
這是一個
好
然後緊接着表現層
就是說
你可以讓他
就是你訪問他的時候
他給你表現成爲什麼
那麼比如說
最經典的
就是可以表現成爲
如果普通圖片的話
可以表現成爲PNG圖片
JPG圖片
什麼樣的圖片
好吧
但是一般來說
我們玩自動化的時候
你就可以讓它表現成爲
一種數據格式
比如說可以是xml的
可以是json的
OK
當然你可以通過
你發送請求的accept
要求它表現成爲json的
還是xml的
當然我這做就沒有這麼講究了
就說只能接受
只能夠接受json的
OK
就說表現
就說你這個支援怎麼表現
可以表現成圖片
表現成網頁
那麼當然我這是自動化的
所以說我你要查詢一個文章
那麼我要表現成爲xml的
或者json的
其實可以
如果說講究一些的話
可以根據客戶的提出的不同要求
然後給它不同的表現形式
當然我這個就沒有表現的這麼複雜了
OK
那麼比如說我們去list
比如說我們去訪問它
我們通過get來訪問它
然後這個時候
它就應該可以表現成爲
表現成爲一個列表
然後裏面一個的文章
其實返回的是相應的json
OK
這就是表現
當然你也可以讓它表現成爲xml
比如說有些
思科的resconf
然後上面的resconf
就可以要求它表現成爲xml
它就在xml的
要求它表現成爲json的
就表現成json的
好吧
好
所謂的狀態轉換
就是可以給它改變它
OK
最經典的就是說
我們可以用get來去獲取它
比如說你看這就是經典的get
我們就可以去得到這個資源的
表現出來的json
或者xml的數據
然後也可以是post
可以去新建一個
就是我們都在狀態轉換
都在改變它
我們可以新建一個
比如說我們可以新建一個
你看我們就可以通過
create
當然其實是post
我們可以新建一個是
好
那這樣你新建了之後
你看它是不是就轉換了
就變化了
因爲你會發現
就多了一個
又多了一個新的數據出來
OK
那這就相當於你是在轉換
你在改變它
OK
當然還有就是delete
你可以把某一個刪掉
比如說你想把id6刪掉
那麼也是在改變它
比如說我們要把id6給刪掉
刪掉之後
我們來看一下我們list
你看id6就沒有了
好吧
那麼也是在轉換
好
當然還可以通過put
一般來說
可能我們會用patch
我用做了一個patch
然後我們可以去修改它
比如說我們想去修改
這個id5
id5更新後的內容5
更新後的標題5
就是這個id5
我們來看一下
好
然後我們重新看一下
list一下
然後你看就改變了
好吧
所以說這就是所謂的狀態轉換
那麼你首先通過一個url來定位一個資源
好
然後你可以讓這個資源有不同的表現形式
然後可以通過get
post
patch
put
delete
來給它做一個狀態的改變和修改
這個方法論做出來的這麼一個API就叫做rest API
好吧
那麼這是一個方法論
其實也不算是什麼一個標準
那麼很多場
這是一個更先進的方法論
好吧
所以現在一般來說
我們來做API的話
基本上都是rest API
但是基本上rest API都是私有的
都是他們家自己設計的
比如說像我這個就可以認爲是一個rest API
很明顯
按照這個方法論
我們通過了URI來定位了一個資源
OK
然後我給它表現成爲json的
當然我這就只能表現成json的
好吧
然後我們可以通過get獲取它
post新建它
delete刪掉它
patch來修改它
都是可以的
好吧
那麼OK
那麼這就是一個經典的方法論
好
那麼當然了
這次我們還要主要講一下如何實現
當然這個代碼裏面都有
我把這個代碼裏面重點的東西給大家介紹一下
首先第一個你需要安裝的模塊
在這個我給它放到了requirements
裏面
這是相關要安裝的
我記得應該是主要是這幾個是要安裝的
我看看
應該就這幾個是要安裝的
好吧
如果說你要去配合open API
要讓它產生相應的文檔的話
我記得是這幾個是要安裝的
對
應該這幾個是要安裝的
OK
也就是說反正requirements都有
你可以按照requirements去安裝
好吧
我這要的模塊都在這
這應該就是DRG想要的東西
我用的最新的jungle5.1.4
然後如果說你要出相應的文檔的話
API的文檔的話
應該是這幾個是需要去做API文檔的
好吧
OK
這是一個需要做的
安裝之後
緊接着我們來看一下
settings
首先我這有一個APP
我自己創建一個APP
然後這個APP裏面
我這數據庫在這
OK
有一個自己創建的一個APP
所以說我們來看一下
這個setting裏面
setting裏面值得注意的
就是說這個APP要加載進來
這樣的話
它的這些模塊裏面的
模塊裏面的數據庫
纔會放到數據庫裏面去
好吧
然後這就是爲了激活REST API
然後這激活了一個API的文檔
對吧
我們現在不僅要有REST API
而且要有swagger在線測試的
這麼一個頁面
而且也應該有OpenAPI的
這麼一個文檔
這是一個全套服務
好吧
我們既有REST API
也有swagger測試
也有OpenAPI的文檔
然後我們也有認證
我們還有https
我們還有跟整個jungle的認證的
整合的這麼一個全線的控制
好吧
OK
那麼這是需要設置的
這是一個需要設置的
好
然後這是rest-fanwork
這也是依然是認證
這是跟認證有關係的
跟認證有關係的
這是跟文檔在線文檔有關係的
好
然後這是你對在線文檔的
一個簡單的介紹
在線文檔的簡單的介紹
我看看
OK
好
那麼如果說是本地玩
如果說是本地玩
我最開始設計的時候
就本地的CircleLight
就本地的CircleLight就可以了
好吧
後來我又封裝到了Docker
所以說如果說是Docker的話
我們可以通過這種方法
來切到pcq
就本地也可以
pcq也可以
好吧
只要你設置環境變量
我們就切到pcq裏面去
大概就是效果
但是你需要安裝這個模塊
看一下里面有這個模塊
要安裝這個模塊
好吧
這樣的話
你就可以通過設置一個
環境變量的方法
來給他設計數據庫
這也是我現學的
O1 Pro告訴我的
因爲我又告訴他
我說我本地是CircleLight
我如何去切換到pcq
通過一個
因爲我是Docker封裝的
希望能夠傳環境變量
就搞定
沒問題
非常靠譜
好吧
然後有需要設一個靜態文件目錄
差不多這個settings
大概就這些東西
好
然後緊接着我們再看一下
剛纔我們目錄下面有數據庫
數據庫
然後這還專門給他做了一個序列化
很簡單
這個很簡單
就是你數據庫
那麼你讀出來之後
那麼最終要給客戶的是一個Jason
所以說這有一個序列化操作
這是你的數據庫
然後這個就是對數據庫
做了一個序列化的操作
這樣的話
最終會給客戶一個Jason
好吧
好
這個也說了
好
我們來看一下
URLs
好
那麼
這兩個
這兩個是用來
一個是用來
get和post的
這是基礎的
就是可以
獲取
可以獲取和新建
好吧
那麼默認
你看一下
這個view位於
我看他這個view位於這
這個用來列出和創建的
就是說get和post
這是最基本的操作
好吧
開始其實就可以的
後來發現
後來發現我
後來我跟他提要求說
我需要去delete
我需要去patch
那這個時候又要再更新一個
這兩個view
一個是
get和post
這個是delete和patch的
好吧
有兩個view
所以說看一下
這個URL的地方
那麼引入了它們
然後這就是用來post和get的
然後這個一定要給個ID
因爲你要去刪掉
你要給ID
你要更新
肯定是要給ID的
好吧
OK
那麼這個就可以了
然後這是一個認證用的認證
這是認證的
認證用來獲取定牌的
需要一個先有一個位置
去獲取定牌
好吧
OK好
然後這個就是跟swagger測試文檔
然後去獲取OpenAPI的文檔
就是這三個就是在線測試的
一會我再測一下
好吧
這個做完了之後
我們就可以簡單的測試一下
首先我們來看一下
我們的gettoken
有一個專門的位置
baseURL可以看一下
baseURL
這是本地測試
這是django的測試
那這是https的
我們先本地測
本地測
那麼這是一個前綴
然後緊接着你就可以通過這個URL
這是做好的
好吧
然後你傳用戶密碼進去
然後就能夠得到他的定牌
然後我返回一個字典
因爲這個字典就是後面的
要插到後續請求裏面的頭部
這是頭部和它的內容是token空格
然後真實獲到的隨機的token
感受一下效果
好
就這樣就得到了定牌
好吧
有了定牌之後
緊接着你就可以去向URL做get
OK
就能得到有些什麼樣的資源
其實還很簡單的
好吧
然後通過就可以create
添加一個什麼東西
添加一個內容
就這個key
OK
好
就這個key
好
然後緊接在那裏
就可以去delete
也是像這個位置要給ID
patch也是這個位置需要給ID
好吧
OK
這就是就可以了
好
然後這是基本的API是好的
然後我們來看一下它的swagger頁面
OK
當然了
我這https是好的
我可以來個https的
應該是
django-drf.qi.com
號6443
https
什麼
https
django
我看看
django-drf.qi.com
好
這是對的
因爲根沒有做
因爲我是API
所以說沒有做根
OK
這個swagger測試的API就是好的
好吧
然後你如果說想認證的話
你就先獲取一個令牌
要把這個貼進去
稍微注意一下
好
你授權完了之後
就可以一樣的
在圖形化界面裏可以去測
invalid token嗎
對了
我要去獲取token
應該是
因爲它是https的
所以說我切過來
然後我再獲取token
這個token就在https裏面的
get
OK
那邊確實只有一個
OK
可以看到
沒問題
可以獲取的
OK
這就是在線的swagger測試的
這麼一個頁面
然後你還可以去下載
OpenAPI定義的文件
基本上是全套活
好吧
就是說測試頁面也有
OpenAPI的文檔也有
那麼在線測試也是可以的
好吧
我這個也做了
OK
好
當然了
你需要提前有一個用戶
我這創建了一個超級用戶
我的命
好吧
我的命
超級用戶
你要創建這個用戶
當然了
這個用戶也可以不一定是超級用戶
也可以是普通用戶
然後你可以有權限
對它進行
你可以用Jungle的權限來進行控制
這樣的話
它就可以限制這個用戶
雖然說你把所有的數據庫都發出來了
但是你可以通過用戶來限制
它哪些數據庫是可以操作的
其他數據庫就操作不了
這是可以的
好吧
我記得現在就沒有什麼可說的了
好
然後緊接着我們來看一下封裝
這個時候我用到了
這是PCQ
然後這是我們的Jungle
OK
這傳入數據庫
它就會設置數據庫
然後傳入這兩個
就會幫你創建相應的超級用戶
用戶就會自動幫你
說實話
好吧
OK
這樣的話
我給你先down一下
從頭來
然後在
Build可能沒有什麼必要了
然後up-d
從頭來
好吧
OK
這個時候我們來看一下
我們的數據庫
數據庫
它自動幫你創建的
這有一個腳本
幫你自動創建
幫你自動做migration
幫你自動等待數據庫起來
OK
這還是非常高級的
自動全部網絡搞定了
好吧
然後封裝到這個裏面來
好
現在我們可以來測一下
我們圖形化界面裏面可以看一下
再重新來
因爲重新拉了
所以說令牌我們重新再走一個
好
然後現在沒有是對的
空了
OK
好
然後我們現在切到了
Https那邊
然後這個時候我們可以創建一個
我們再創建
我這個做了兩個
其實做一個就行
每次都創建兩遍
我因爲在這做了一個衣服
我就說每次怎麼做兩個
好吧
OK
好
那這就可以
看看圖形界面這邊
看到就有數據了
沒問題吧
OK
好
然後你在這也可以列出
也可以列出
OK
然後再列出創建
沒問題
好
然後可以刪掉
我們也可以在圖形化界面裏面來刪
我這有個ID
比如ID4
那麼我比如說我要
Delete一個
好
走裏
Try it
然後我要Delete哪個
Delete
4ID爲4的
然後我走裏
執行好了
然後這個時候我再列一下
ID4不就沒有了
圖形化界面也可以測
好吧
文檔也有
好吧
然後在這也可以測
好
然後改
我們同樣的看一下
改
ID3
我們改ID
這個代碼就是改ID1的
改ID1
改了
看看
沒有ID1
我的ID1去哪了
這才ID1
好吧
改了
好吧
沒問題
那麼基本上就差不多
就這些
那麼當然了
最重要的
你是可以去看看代碼
我給你從頭到尾給你走了一遍
把關鍵點給說了說
好吧
全部都給你封裝到了Docker Compose
但是其實也無需語言
因爲Docker Compose裏面啥都有
OK
這些粗俗話
這些全部Docker的好處
在於全部都封裝到這兒了
你看不看得懂是你的問題
好吧
OK
今天就講到這
我覺得還是非常不錯的
通過這個我講了
REST API是什麼
OK
然後也展示了它的效果
它能把整個數據庫發出來
然後可以有權限的控制
有token的認證
OK
然後其實整體的操作還是比較簡單的
好吧
我覺得還是非常實用的
我準備後續就把我們公司那些發佈出來
然後做一個用戶
做一些權限控制
有令牌認證
有HTTPS
整體非常的完整
整個功能都全部演示了
好吧
