Java应用开发（中、高级）课件 任务2.1 编写接口设计文档

项目2

服务接口应用开发与测试

学习目标本项目主要学习使用JavaEE开源框架编写API接口提供数据存储、通讯、各类服务等功能。掌握使用SpringBoot框架构建后端项目,以及用项目管理工具Maven对Java项目进行构建、依赖管理。为保证API接口的授权访问，掌握使用通过SpringSecurity框架和JWT完成接口的权限控制功能。同时通过标准软件开发过程实践，熟悉接口设计、编码和测试标准流程以及编写相关的文档。

项目介绍将项目二的餐厅点餐系统使用服务接口的设计思路进行改造升级，为前后端分离架构开发提供后端服务支撑，使用主流的开发框架SpringBoot，结合常用的SpringMVC、Mybatis、SpringSecurity等技术框架实现登录认证、用户管理、菜品管理等接口功能。

知识结构

任务一

编写接口设计文档01

任务描述本任务主要是编写项目的接口设计文档，作为后续开发接口的标准。

知识准备1）接口设计文档在项目开发中，采用前后端分离架构开发，就需要由前后端开发工程师共同定义接口，编写接口文档，之后开发人员需根据这个接口文档进行开发，到项目结束前都要一直维护还项目文档。2）接口文档作用●约束：在前后端合作开发的项目中，可能会出现前后端开发人员对接口理解不一致的情况，在这个时候，接口设计文档就起到了约束的作用。●规范：在项目中通常会由多个开发人员协同完成，如果没有接口设计文档，代码的实现逻辑就可能差别很大，从而降低开发效率，增加维护成本。通过接口设计文档，就可以规范项目中接口的实现思路，方便后期人员查看、维护。

任务实施步骤1：编写接口文档的项目介绍前言项目概述本系统是应用于餐厅的点餐系统，共实现了3种角色及其他功能，分别是餐厅服务员的点餐、提效结账功能；后厨的配菜功能；管理员的结账、用户管理等功能。从而实现餐厅管理信息化的作用，同时也有效提升了点餐、配菜、结账等工作的效率。用户故事根据用户故事识别系统必须处理的各种请求，识别出应用程序的核心系统操作，见用户故事接口表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设计菜品管理、订单流程的接口设计。

知识小结本任务主要是编写项目的接口设计文档，在编写文档过程中了解项目接口设计的基本内容，掌握接口文档的基本结构和接口规范。编写