1. 程式人生 > >RESTful 賬號管理API設計示例

RESTful 賬號管理API設計示例

    RESTful簡介:REST(英文:Representational State Transfer,簡稱REST)描述了一個架構樣式的網路系統,比如 web 應用程式。它首次出現在 2000 年 Roy Fielding 的博士論文中,他是 HTTP 規範的主要編寫者之一。在目前主流的三種Web服務互動方案中,REST相比於SOAP(Simple Object Access protocol,簡單物件訪問協議)以及XML-RPC更加簡單明瞭,無論是對URL的處理還是對Payload的編碼,REST都傾向於用更加簡單輕量的方法設計和實現。值得注意的是REST並沒有一個明確的標準,而更像是一種設計的風格。這裡推薦一個非常讚的解釋:https://zhuanlan.zhihu.com/p/30396391

    賬號管理RESTful API 設計示例:

1.註冊賬號

功能

註冊賬號

請求方式

POST

服務路徑

/Account/info

路徑引數/描述

引數型別

application/json

引數描述

{AccountName:””,

AccountPWD:””,

WeiXin:””,

ZhiFuBao:””,

Phone:””}

備註:AccountName:賬戶名稱 

AccountPWD:賬戶密碼

WeiXin:微信名稱

ZhiFuBao:支付寶名稱

Phone:使用者手機號

返回值型別

application/json

描述

操作成功:{result:0}

操作失敗:{result:1,ErrorMessage:””}

2.賬號更新

功能

更新資訊

請求方式

PUT

服務路徑

/Account/info

路徑引數/描述

引數型別

application/json

引數描述

{AccountName:””,

AccountPWD:””,

AccountStatus:””,

Money:””,

WeiXin:””,

ZhiFuBao:””,

Phone:””}

備註:AccountName:賬戶名稱 

AccountPWD:賬戶密碼

Phone:使用者手機號

AccountStatus:賬戶狀態 解釋-1:鎖定 0:正常 1:稽核中 2:未通過稽核

WeiXin:微信名稱

ZhiFuBao:支付寶名稱

Money:賬戶餘額

返回值型別

application/json

描述

操作成功:{result:0}

操作失敗:{result:1,ErrorMessage:””}

3.賬號類別查詢

功能

賬號類別查詢

請求方式

GET

服務路徑

/Account/info/{AccountName}

路徑引數/描述

AccountName:賬戶名稱 

引數型別

引數描述

返回值型別

application/json

描述

操作成功:{result:0AccountType””}

AccountType:賬戶類別

操作失敗:{result:1,ErrorMessage:””}

4.刪除賬號

功能

賬號刪除

請求方式

DELETE

服務路徑

/Account/info/

路徑引數/描述

AccountName:賬戶名稱 

引數型別

引數描述

返回值型別

application/json

描述

操作成功:{result:0AccountType””}

AccountType:賬戶類別

操作失敗:{result:1,ErrorMessage:””}


5.賬號登入

功能

賬號登入

請求方式

POST

服務路徑

/Account/authorization

路徑引數/描述

引數型別

application/json

引數描述

{AccountName:””,

AccountPWD:””}

備註:AccountName:賬戶名稱 

AccountPWD:賬戶密碼

返回值型別

application/json

描述

操作成功:{result:0}

操作失敗:{result:1,ErrorMessage:””}

6.賬號登出

功能

賬號登出

請求方式

DELETE

服務路徑

/Account/authorization

路徑引數/描述

AccountName:賬戶名稱 

引數型別

引數描述

 {AccountName}

返回值型別

application/json

描述

操作成功:{result:0}

操作失敗:{result:1,ErrorMessage:””}


相關推薦

RESTful 賬號管理API設計示例

    RESTful簡介:REST(英文:Representational State Transfer,簡稱REST)描述了一個架構樣式的網路系統,比如 web 應用程式。它首次出現在 2000 年 Roy Fielding 的博士論文中,他是 HTTP 規範的主要編寫者

【小家java】 Restful風格的API設計中,怎麼實現批量刪除?

相關閱讀 每篇一句 面試高大上,面試造飛機,工作擰螺絲 因此不能以為自己工作覺得還OK,就覺得自己技術還不錯了 如題,指的是在restful風格的url設計中,怎麼實現批量刪除呢? 這裡指的刪除是真刪除,不是邏輯刪除。如果是邏輯刪除,其實就是upd

RESTful API 設計指南

head 簡單 option eat set 取出 tro 其他 first   網絡應用程序,分為前端和後端兩個部分。當前的發展趨勢,就是前端設備層出不窮(手機、平板、桌面電腦、其他專用設備……)。   因此,必須有一種統一的機制,方便不同的前端設備與後端進行通信。這

API設計規範 ----Restful

creat cif created 排序 href use 服務 如果 pat    Restful API設計指南 接下來我將介紹RESTful API的設計細節,探討如何設計一套合理、好用的API 一、協議 API與用戶的通信協議,總是使用HTTPs協議。

Restful API設計

rfc mage erro art 狀態 存在 asc tar 區分 理解RESTful架構 越來越多的人開始意識到,網站即軟件,而且是一種新型的軟件。 這種"互聯網軟件"采用客戶端/服務器模式,建立在分布式體系上,通過互聯網通信,具有高延時(high latency

Restful API 設計參考原則

width 包裝 修改 api開發 司機 word 屬性 add 數據返回 在項目中,需要為後臺服務撰寫API。剛開始接觸的時候,並沒有考慮太多,就想提供URL,服務端通過該URL進行查詢、創建、更新等操作即可。但再對相關規範進行了解後,才發現,API的設計並沒有那麽簡單,

API設計RESTful API 設計指南

sys i/o ani sta 所有 com 訪問 指定 名詞 RESTful API URL定位資源,用HTTP動詞(GET,POST,DELETE,DETC)描述操作。 例如 1. REST描述的是在網絡中client和server的一種交互形式;REST本身不實

Python Restful API設計規範

探討 資源 表現層 gin htm 異步任務 sci 在服務器 type Python 之路,Restful API設計規範 理解RESTful架構 Restful API設計指南 理解RESTful架構 越來越多的人開始意識到,網站即軟件

RESTful API設計規範收集

版本控制 執行 tap cep 冪等性 解耦 sdn hyperlink radi 說明:其實沒有絕對的規範,達到90%即可。 理解RESTful架構:http://www.ruanyifeng.com/blog/2011/09/restful.html RESTful

理解RESTful架構——Restful API設計指南

eval 高並發 服務器 ani eric 互聯網通信 info ati 排序 理解RESTful架構 Restful API設計指南 理解RESTful架構 越來越多的人開始意識到,網站即軟件,而且是一種新型的軟件。 這種"互聯網軟件"采用客戶端/服務器模式,建立

RESTful API設計方法

伸縮性 提高 php 加網 結構 機制 事情 統架構 網頁 1.如果已經開始逐步的接觸到了RESTful API設計方法的朋友,首先要對HTTP/HTTPS有一個大致的了解,雖然本身和RESTful API沒有什麽關系。但是對於增加網站的安全性還是十分重要的,這裏就涉及到了

我所理解的RESTful Web API [設計篇]

一個 nta 協議 cti 提交 李維 目前 web api 介紹 本文轉載自文章:我所理解的RESTful Web API [設計篇]。 其他參考文章有:RESTful 介紹 ppt,Restful的理解,Restful 優缺點,理解RESTful架構,RESTfu

RESTful API 設計最佳實踐

並不是 要求 關於 bin 是我 最好 實用 link keep 數據模型已經穩定,接下來你可能需要為web(網站)應用創建一個公開的API(應用程序編程接口)。需要認識到這樣一個問題:一旦API發布後,就很難對它做很大的改動並且保持像先前一樣的正確性。現在,網絡上有很

Restful API設計規範

理解RESTful架構 Restful API設計指南     理解RESTful架構 越來越多的人開始意識到,網站即軟體,而且是一種新型的軟體。 這種"網際網路軟體"採用客戶端/伺服器模式,建立在分散式體系上,通過網際網路通訊,具有高延時(high latency)、高併發等

11. RESTful API 設計最佳實踐

API 設計規範 API 設計規範 URI 的設計 過濾、排序和搜尋等資訊 響應和錯誤處理 版本控制(delete) 認證 快取 未完待續… 其他規範可參考

RESTful架構與RESTful API設計

一、REST的由來   REST這個詞是Roy Thomas Fielding博士在他2000年的博士論文中提出的,Fielding將他對網際網路軟體的架構原則定名為REST,即Representational State Transfer的縮寫,翻譯為“表現層狀態轉化”。如果一個架

SpringBoot系列: 設計Restful風格的API

RESTful 架構REST 並非一種技術或規範, 而是一種架構風格, 如果一個架構符合Rest的約束條件和原則, 就可以稱作是 RESTful 架構. REST全稱是Representational State Transfer, 省略了定語 Resource, 完整的講法是"資源表現性狀態轉移", 要設計

RESTful API 設計指南——最佳實踐

RESTful API 設計指南——最佳實踐 Facebook、谷歌、Github、Netflix 和幾個其他的科技巨頭已經允許開發者和其產品通過 API 呼叫他們的資料,併為他們提供平臺。即使你不是寫 API 的專業人士,擁有精美的 API 也對你的應用程式有好處。 關於設計 API 的最

Restful API設計思路

Restful API是目前比較成熟的一套網際網路應用程式的API設計理念,Rest是一組架構約束條件和原則,如何Rest約束條件和原則的架構,我們就稱為Restful架構,Restful架構具有結構清晰、符合標準、易於理解以及擴充套件方便等特點,受到越來越多網站的採用! Restful API

Zookeeper C API應用示例(3)——配置管理(非同步API

場景描述同:https://blog.csdn.net/qq_41688455/article/details/83780854 服務端程式碼如下: #include <stdio.h> #include <unistd.h> #include <std