![]()
![]()
开发前的接口文件(API文档):
接口文件(API Specification)
用户注册接口文档
1. 接口基本信息
| 项目 | 说明 |
|---|
| 接口名称 | 用户注册提交接口 |
| 接口路径 | /reg |
| 请求方法 | POST |
| 内容类型 | application/x-www-form-urlencoded |
| 返回类型 | 视图页面(JSP) |
2. 请求参数
| 参数名 | 类型 | 必填 | 说明 | 示例值 |
|---|
| name | String | 是 | 用户姓名 | “张三” |
| age | Integer | 是 | 用户年龄 | 25 |
请求示例
POST /reg HTTP/1.1 Host: localhost:8080 Content-Type: application/x-www-form-urlencoded name=张三&age=25
3. 响应说明
成功响应
| 项目 | 说明 |
|---|
| 状态码 | 200 OK |
| 返回视图 | reg-result2 |
| 视图路径 | /WEB-INF/jsp/reg-result2.jsp |
响应数据(Model属性)
| 属性名 | 类型 | 说明 | 示例值 |
|---|
| userName | String | 用户姓名 | “张三” |
| userAge | Integer | 用户年龄 | 25 |
响应示例(JSP页面渲染后)
<!DOCTYPEhtml><html><head><title>注册结果</title></head><body><h1>注册成功!</h1><p>姓名:张三</p><p>年龄:25</p></body></html>