Java應(yīng)用開發(fā)（中、高級(jí)）課件 任務(wù)2.1 編寫接口設(shè)計(jì)文檔

項(xiàng)目2

服務(wù)接口應(yīng)用開發(fā)與測(cè)試

學(xué)習(xí)目標(biāo)本項(xiàng)目主要學(xué)習(xí)使用JavaEE開源框架編寫API接口提供數(shù)據(jù)存儲(chǔ)、通訊、各類服務(wù)等功能。掌握使用SpringBoot框架構(gòu)建后端項(xiàng)目,以及用項(xiàng)目管理工具M(jìn)aven對(duì)Java項(xiàng)目進(jìn)行構(gòu)建、依賴管理。為保證API接口的授權(quán)訪問，掌握使用通過SpringSecurity框架和JWT完成接口的權(quán)限控制功能。同時(shí)通過標(biāo)準(zhǔn)軟件開發(fā)過程實(shí)踐，熟悉接口設(shè)計(jì)、編碼和測(cè)試標(biāo)準(zhǔn)流程以及編寫相關(guān)的文檔。

項(xiàng)目介紹將項(xiàng)目二的餐廳點(diǎn)餐系統(tǒng)使用服務(wù)接口的設(shè)計(jì)思路進(jìn)行改造升級(jí)，為前后端分離架構(gòu)開發(fā)提供后端服務(wù)支撐，使用主流的開發(fā)框架SpringBoot，結(jié)合常用的SpringMVC、Mybatis、SpringSecurity等技術(shù)框架實(shí)現(xiàn)登錄認(rèn)證、用戶管理、菜品管理等接口功能。

知識(shí)結(jié)構(gòu)

任務(wù)一

編寫接口設(shè)計(jì)文檔01

任務(wù)描述本任務(wù)主要是編寫項(xiàng)目的接口設(shè)計(jì)文檔，作為后續(xù)開發(fā)接口的標(biāo)準(zhǔn)。

知識(shí)準(zhǔn)備1）接口設(shè)計(jì)文檔在項(xiàng)目開發(fā)中，采用前后端分離架構(gòu)開發(fā)，就需要由前后端開發(fā)工程師共同定義接口，編寫接口文檔，之后開發(fā)人員需根據(jù)這個(gè)接口文檔進(jìn)行開發(fā)，到項(xiàng)目結(jié)束前都要一直維護(hù)還項(xiàng)目文檔。2）接口文檔作用●約束：在前后端合作開發(fā)的項(xiàng)目中，可能會(huì)出現(xiàn)前后端開發(fā)人員對(duì)接口理解不一致的情況，在這個(gè)時(shí)候，接口設(shè)計(jì)文檔就起到了約束的作用。●規(guī)范：在項(xiàng)目中通常會(huì)由多個(gè)開發(fā)人員協(xié)同完成，如果沒有接口設(shè)計(jì)文檔，代碼的實(shí)現(xiàn)邏輯就可能差別很大，從而降低開發(fā)效率，增加維護(hù)成本。通過接口設(shè)計(jì)文檔，就可以規(guī)范項(xiàng)目中接口的實(shí)現(xiàn)思路，方便后期人員查看、維護(hù)。

任務(wù)實(shí)施步驟1：編寫接口文檔的項(xiàng)目介紹前言項(xiàng)目概述本系統(tǒng)是應(yīng)用于餐廳的點(diǎn)餐系統(tǒng)，共實(shí)現(xiàn)了3種角色及其他功能，分別是餐廳服務(wù)員的點(diǎn)餐、提效結(jié)賬功能；后廚的配菜功能；管理員的結(jié)賬、用戶管理等功能。從而實(shí)現(xiàn)餐廳管理信息化的作用，同時(shí)也有效提升了點(diǎn)餐、配菜、結(jié)賬等工作的效率。用戶故事根據(jù)用戶故事識(shí)別系統(tǒng)必須處理的各種請(qǐng)求，識(shí)別出應(yīng)用程序的核心系統(tǒng)操作，見用戶故事接口表3-1。t

任務(wù)實(shí)施步驟1：編寫接口文檔的項(xiàng)目介紹t表3-1用戶故事接口表

任務(wù)實(shí)施步驟1：編寫接口文檔的項(xiàng)目介紹t功能模塊根據(jù)用戶故事，將接口大致劃分為幾個(gè)模塊，詳情表3-2：表3-2功能模塊表

任務(wù)實(shí)施步驟2：編寫登錄模塊的接口設(shè)計(jì)t1）用戶登錄模塊接口描述

用戶登錄模塊接口描述見表3-3表3-3登錄功能接口表

任務(wù)實(shí)施步驟2：編寫登錄模塊的接口設(shè)計(jì)t2）用戶登錄接口設(shè)計(jì)(1)接口說明：請(qǐng)求方式為“POST”，請(qǐng)求地址為“/login”。(2)功能說明：用戶通過提交用戶名和密碼，獲取授權(quán)的token標(biāo)志，并獲取用戶信息。(3)請(qǐng)求參數(shù)（輸入值）見表3-4。表3-4登錄接口參數(shù)表

任務(wù)實(shí)施步驟2：編寫登錄模塊的接口設(shè)計(jì)t(4)響應(yīng)參數(shù)（輸出值）見表3-5。表3-5登錄接口響應(yīng)表

任務(wù)實(shí)施步驟2：編寫登錄模塊的接口設(shè)計(jì)t（5）輸出值JSON格式示例

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t用戶管理用戶管理接口見表3-6

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t1）用戶列表接口設(shè)計(jì)（1）接口說明：請(qǐng)求方式為“GET”，請(qǐng)求地址為“/admin/user/getuserbypage”。（2）功能說明：通過分頁頁碼，查詢列表數(shù)據(jù)。（3）請(qǐng)求參數(shù)（輸入值）見表3-7。

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t(4)響應(yīng)參數(shù)（輸出值）見表3-5。

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t（5）輸出值JSON格式示例

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t2）新增用戶接口設(shè)計(jì)（1）接口說明：請(qǐng)求方式為“POST”，請(qǐng)求地址為“/admin/user/adduser”。（2）功能說明：新增一條用戶記錄。（3）請(qǐng)求參數(shù)（輸入值）：UserInfo見表3-9。

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t(4)響應(yīng)參數(shù)（輸出值）見表3-10。

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t（5）輸出值JSON格式示例

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t3）刪除用戶接口設(shè)計(jì)（1）接口說明：請(qǐng)求方式為“POST”，請(qǐng)求地址為“/admin/user/deleteuser”。（2）功能說明：刪除一條用戶記錄。（3）請(qǐng)求參數(shù)（輸入值）見表3-11。

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t(4)響應(yīng)參數(shù)（輸出值）見表3-12。

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t（5）輸出值JSON格式示例

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t4）更新用戶接口設(shè)計(jì)（1）接口說明：請(qǐng)求方式為“POST”，請(qǐng)求地“/admin/user/adminmodifyuser”。（2）功能說明：更新用戶記錄。（3）請(qǐng)求參數(shù)（輸入值）見表3-13。

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t(4)響應(yīng)參數(shù)（輸出值）見表3-14。

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t（5）輸出值JSON格式示例

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t5）查詢用戶接口設(shè)計(jì)（1）接口說明：請(qǐng)求方式為“GET”，請(qǐng)求地址為“/admin/user/get”。（2）功能說明：通過用戶ID查詢數(shù)據(jù)。（3）請(qǐng)求參數(shù)（輸入值）見表3-15。

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t(4)響應(yīng)參數(shù)（輸出值）見表3-16。

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t（5）輸出值JSON格式示例

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t6）驗(yàn)證用戶名是否可用的接口設(shè)計(jì)（1）接口說明：請(qǐng)求方式為“POST”，請(qǐng)求地址為“/admin/user/checkuser”。（2）功能說明：檢查用戶名是否可用。（3）請(qǐng)求參數(shù)（輸入值）見表3-17

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t(4)響應(yīng)參數(shù)（輸出值）見表3-18。

任務(wù)實(shí)施步驟3：編寫用戶管理模塊的接口設(shè)計(jì)t（5）輸出值JSON格式示例

拓展練習(xí)按照該任務(wù)的步驟2、3設(shè)計(jì)菜品管理、訂單流程的接口設(shè)計(jì)。

知識(shí)小結(jié)本任務(wù)主要是編寫項(xiàng)目的接口設(shè)計(jì)文檔，在編寫文檔過程中了解項(xiàng)目接口設(shè)計(jì)的基本內(nèi)容，掌握接口文檔的基本結(jié)構(gòu)和接口規(guī)范。編寫