Java應用開發(fā)（中、高級）課件 任務2.1 編寫接口設計文檔

項目2

服務接口應用開發(fā)與測試

學習目標本項目主要學習使用JavaEE開源框架編寫API接口提供數據存儲、通訊、各類服務等功能。掌握使用SpringBoot框架構建后端項目,以及用項目管理工具Maven對Java項目進行構建、依賴管理。為保證API接口的授權訪問，掌握使用通過SpringSecurity框架和JWT完成接口的權限控制功能。同時通過標準軟件開發(fā)過程實踐，熟悉接口設計、編碼和測試標準流程以及編寫相關的文檔。

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

知識結構

任務一

編寫接口設計文檔01

任務描述本任務主要是編寫項目的接口設計文檔，作為后續(xù)開發(fā)接口的標準。

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

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

任務實施步驟1：編寫接口文檔的項目介紹t表3-1用戶故事接口表

任務實施步驟1：編寫接口文檔的項目介紹t功能模塊根據用戶故事，將接口大致劃分為幾個模塊，詳情表3-2：表3-2功能模塊表

任務實施步驟2：編寫登錄模塊的接口設計t1）用戶登錄模塊接口描述

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

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

任務實施步驟2：編寫登錄模塊的接口設計t(4)響應參數（輸出值）見表3-5。表3-5登錄接口響應表

任務實施步驟2：編寫登錄模塊的接口設計t（5）輸出值JSON格式示例

任務實施步驟3：編寫用戶管理模塊的接口設計t用戶管理用戶管理接口見表3-6

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

任務實施步驟3：編寫用戶管理模塊的接口設計t(4)響應參數（輸出值）見表3-5。

任務實施步驟3：編寫用戶管理模塊的接口設計t（5）輸出值JSON格式示例

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

任務實施步驟3：編寫用戶管理模塊的接口設計t(4)響應參數（輸出值）見表3-10。

任務實施步驟3：編寫用戶管理模塊的接口設計t（5）輸出值JSON格式示例

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

任務實施步驟3：編寫用戶管理模塊的接口設計t(4)響應參數（輸出值）見表3-12。

任務實施步驟3：編寫用戶管理模塊的接口設計t（5）輸出值JSON格式示例

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

任務實施步驟3：編寫用戶管理模塊的接口設計t(4)響應參數（輸出值）見表3-14。

任務實施步驟3：編寫用戶管理模塊的接口設計t（5）輸出值JSON格式示例

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

任務實施步驟3：編寫用戶管理模塊的接口設計t(4)響應參數（輸出值）見表3-16。

任務實施步驟3：編寫用戶管理模塊的接口設計t（5）輸出值JSON格式示例

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

任務實施步驟3：編寫用戶管理模塊的接口設計t(4)響應參數（輸出值）見表3-18。

任務實施步驟3：編寫用戶管理模塊的接口設計t（5）輸出值JSON格式示例

拓展練習按照該任務的步驟2、3設計菜品管理、訂單流程的接口設計。

知識小結本任務主要是編寫項目的接口設計文檔，在編寫文檔過程中了解項目接口設計的基本內容，掌握接口文檔的基本結構和接口規(guī)范。編寫