resful規範: 進行數據交換時的代碼潛規則

来源:https://www.cnblogs.com/ayongxin93/archive/2019/11/24/11923740.html
-Advertisement-
Play Games

目前主流的三種web服務交互方案: REST (Representational State Transfer) 表徵性狀態轉移 SOAP (Simple Object Access Protocol)簡單的對象訪問協議 XML RPC (XML Remote Procedure Call)基於XM ...


目前主流的三種web服務交互方案:

REST (Representational State Transfer) 表徵性狀態轉移
SOAP (Simple Object Access Protocol)簡單的對象訪問協議
XML-RPC (XML Remote Procedure Call)基於XML的遠程過程調用

但最為流行最為常用就是restful,而當一個架構符合REST的約束條件和原則,我們就稱它為restful架構。
為了避免明文傳輸,更好的維護數據傳輸時的安全性,restful規範推薦使用https替代http。

1.restful規範就是在想要完成程式間數據交互的代碼時所需要的遵循的規範,它視網上的一切數據為資源,所有的操作都是在對資源進行增刪改查,所以這是一種面向資源式的編程。
2..如果說資料庫就是資源庫,那麼URL就是用於檢索的目錄和直達資源的高速路。為了避免歧路亡羊的事情發生,所以在編寫URL的時候必須遵循固定的規範,表達出的信息也要清晰明確,不至於產生歧義。
在URL中要明確體現一下幾點:
1.api標識:http://www.xxxx.com/api/...
2.版本信息:http://www.xxxx.com/api/v1...
3.用名詞而不是動詞來表示所訪問資源的種類,所用名詞往往與資料庫表格的名稱相同

3.如果要通過在url中添加一些篩選條件,實現對資源的精准定位和對狀態的精確控制,一般是以?+關鍵字= int整型 (需要在前段做好正則匹配)
http://www.luffycity.com/api/user/?page=1&type=9 #

4.restful規範下的URL代碼比FBV下的URL要更加精簡,只需要一個URL就能完成所有操作,因為他是根據不同的請求方法來判斷對數據進行何種操作,而不需要分別為增刪改查各設置一個URL。

  1. 返回值:要以json的形式返回值,delete的返回值為空
    GET http://www.luffycity.com/api/user/
    [
    {'id':1,'name':'alex','age':19},
    {'id':1,'name':'alex','age':19},
    ]
    POST http://www.luffycity.com/api/user/
    {'id':1,'name':'alex','age':19}

     GET http://www.luffycity.com/api/user/2/
         {'id':2,'name':'alex','age':19}
    
     PUT http://www.luffycity.com/api/user/2/
         {'id':2,'name':'alex','age':19}
    
     PATCH https//www.luffycity.com/api/user/2/
         {'id':2,'name':'alex','age':19}
    
     DELETE https//www.luffycity.com/api/user/2/
         空
    6.給用戶返回狀態碼:
    - 200,成功
    • 300,301永久 /302臨時
    • 400,403拒絕 /404找不到
    • 500,服務端代碼錯誤
  2. 操作異常時,要返回錯誤信息

     {
         error: "Invalid API key"}
  3. 要為可能跳轉的下一個網頁要提供介面:Hypermedia AP
    {
    'id':2,
    'name':'alex',
    'age':19,
    'depart': "http://www.xxx.com/api/user/30/"
    }


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • MyBatis 是一款優秀的持久層框架,它支持定製化 SQL、存儲過程以及高級映射。MyBatis 避免了幾乎所有的 JDBC 代碼和手動設置參數以及獲取結果集。MyBatis 可以使用簡單的 XML 或註解來配置和映射原生類型、介面和 Java 的 POJO(Plain Old Java Obje... ...
  • 我們在進行項目的多環境配置時,有很多種方式供我們選擇,比如 SpringBoot 自帶的 application dev.yml、maven 的 profile 等。這裡介紹的就是如何利用 profile 進行多環境配置。 首先,在 pom.xml 中添加你需要的 profile 配置: profi ...
  • 本文主要對Java IO相關知識點做了結構性梳理,包括了Java IO的作用,數據源File類,輸入流,輸出流,位元組流,字元流,以及緩衝流,不同場景下的更細化的流操作類型,同時用了一個文件拷貝代碼簡單地說明瞭主要的流操作 ...
  • 新聞 "相遇WebWindow,.NET Core上的跨平臺webview類庫" "使用Bolero在WebAssembly中運行F " "用於你團隊代碼庫的AI輔助IntelliSense" "Jupyter Notebook里的ML.NET" 視頻及幻燈片 "Monads" "使用React,E ...
  • FBV 基於函數的視圖 (function base views) CBV 基於類的視圖 (class base views) 也就是說我們是用函數編寫視圖~還是類編寫視圖~~我們來看下兩個的簡單實現~~ urlpatterns = [ path(‘admin/‘, admin.site.urls) ...
  • 一.hashlib(md5) 1 import hashlib 2 obj = hashlib.md5('dsfd'.encode('utf-8')) 3 obj.update('123'.encode('utf-8')) 4 print(obj.hexdigest()) 二.random 1.ra ...
  • verilog語言簡介 verilog語言是一種語法類似於c的語言,但是與c語言也有不同之處,比如: 1.verilog語言是並行的,每個always塊都是同時執行,而c語言是順序執行的 2.verilog又被稱作硬體描述語言,在用verilog語言編程的時候,不如說是在用verilog描述一段電路 ...
  • [TOC] 靜態文件 預設情況下所有的html文件都是放在templates文件夾內 什麼是靜態文件 網站所使用的提前寫的css、js 第三方的前端模塊、圖片都叫做靜態資源 預設情況下網站使用的靜態資源全部會放到static文件夾下 通常情況下 在static文件夾內部還會再建其他文件夾 這是為了更 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...