web应用技术第8次课(1)--诗人管理接口文档创建数据库

web应用技术第8次课(1)--诗人管理接口文档创建数据库

一、诗人管理接口文档

1. 概述

本文档描述诗人信息管理相关的API接口,包括诗人信息的查询和删除功能。

基础信息:

  • 响应格式:JSON
  • 字符编码:UTF-8

2. 通用响应格式

2.1 成功响应(含数据)

{"code":1,"msg":"success","data":{}}

2.2 成功响应(无数据)

{"code":1,"msg":"success","data":null}

2.3 失败响应

{"code":0,"msg":"错误描述信息","data":null}

2.4 响应字段说明

字段类型说明
codeInteger响应码:1-成功,0-失败
msgString响应信息描述
dataObject返回的数据对象

3. 数据模型

3.1 诗人对象(Peot)

字段类型说明是否必填
idInteger诗人ID(主键)
authorString作者姓名
genderString性别
dynastyString朝代
titleString诗词标题
styleString诗词风格

4. API接口

4.1 查询全部诗人(返回Result格式)

接口描述:查询所有诗人信息,返回标准Result格式响应

请求信息:

项目说明
请求URL/peotfindAllJson
请求方法GET
请求参数

响应示例(成功):

{"code":1,"msg":"success","data":[{"id":1,"author":"李白","gender":"男","dynasty":"唐","title":"静夜思","style":"浪漫主义"},{"id":2,"author":"杜甫","gender":"男","dynasty":"唐","title":"春望","style":"现实主义"}]}

响应示例(失败):

{"code":0,"msg":"查询失败","data":null}

4.2 查询全部诗人(返回List格式)

接口描述:查询所有诗人信息,直接返回诗人列表

请求信息:

项目说明
请求URL/peotfindAll
请求方法GET
请求参数

响应示例(成功):

[{"id":1,"author":"李白","gender":"男","dynasty":"唐","title":"静夜思","style":"浪漫主义"},{"id":2,"author":"杜甫","gender":"男","dynasty":"唐","title":"春望","style":"现实主义"}]

响应示例(失败):异常情况返回错误页面或空列表


4.3 根据ID删除诗人(路径参数)

接口描述:根据诗人ID删除指定诗人信息

请求信息:

项目说明
请求URL/deletebyID/{id}
请求方法GET
请求参数路径参数

请求参数说明:

参数名位置类型必填说明
idPathInteger诗人ID

请求示例:

GET /deletebyID/1

响应示例(成功):
无返回值(void),HTTP状态码200表示成功

响应示例(失败):
抛出异常,返回错误信息


4.4 根据ID删除诗人(请求参数)

接口描述:根据诗人ID删除指定诗人信息

请求信息:

项目说明
请求URL/deletebyID
请求方法GET
请求参数Query参数

请求参数说明:

参数名位置类型必填说明
idQueryInteger诗人ID

请求示例:

GET /deletebyID?id=1

响应示例(成功):
无返回值(void),HTTP状态码200表示成功

响应示例(失败):
抛出异常,返回错误信息


5. 错误码说明

错误码说明
1操作成功
0操作失败

二、创建数据库表

use 自己数据库的名称;--诗人表 create tablepeom(id int unsigned primary key auto_increment comment'ID',authorvarchar(100)comment'姓名',gendervarchar(4)comment'性别, 1:男, 2:女',dynastyvarchar(100)comment'朝代',titlevarchar(100)comment'头衔',stylevarchar(100)comment'风格')comment'诗人表';--测试数据 insert intopeom(id,author,gender,dynasty,title,style)VALUES(null,'陶渊明','1','东晋末至南朝宋初期','诗人和辞赋家','古今隐逸诗人之宗');insert intopeom(id,author,gender,dynasty,title,style)VALUES(null,'王维','1','唐代','诗佛','空灵、寂静');insert intopeom(id,author,gender,dynasty,title,style)VALUES(null,'李商隐','2','唐代','诗坛鬼才','无');insert intopeom(id,author,gender,dynasty,title,style)VALUES(null,'李白','1','唐代','诗仙','豪放飘逸的诗风和丰富的想象力');insert intopeom(id,author,gender,dynasty,title,style)VALUES(null,'李清照','2','宋代','女词人','婉约风格');insert intopeom(id,author,gender,dynasty,title,style)VALUES(null,'杜甫','1','唐代','诗圣','反映社会现实和人民疾苦');insert intopeom(id,author,gender,dynasty,title,style)VALUES(null,'苏轼','1','北宋','文学家、书画家,诗神','清新豪健的诗风和独特的艺术表现力');