需求
需求¶
PetClinic_Rest 是一个宠物诊所管理系统的后端 RESTful API 接口,为前端提供了宠物、医生、预约等相关数据的增删改查功能。
2. 接口列表¶
2.1 宠物接口¶
2.1.1 获取宠物列表¶
- 请求路径:/pets
- 请求方法:GET
- 请求参数:无
- 返回结果:宠物列表的 JSON 数组
2.1.2 获取特定宠物信息¶
- 请求路径:/pets/{petId}
- 请求方法:GET
- 请求参数:petId,宠物的唯一标识
- 返回结果:特定宠物的 JSON 对象
2.1.3 创建宠物¶
- 请求路径:/pets
- 请求方法:POST
- 请求参数:新宠物的 JSON 对象
- 返回结果:新宠物的 JSON 对象
2.1.4 更新宠物信息¶
- 请求路径:/pets/{petId}
- 请求方法:PUT
- 请求参数:petId,宠物的唯一标识;更新后的宠物信息的 JSON 对象
- 返回结果:更新后的宠物的 JSON 对象
2.1.5 删除宠物¶
- 请求路径:/pets/{petId}
- 请求方法:DELETE
- 请求参数:petId,宠物的唯一标识
- 返回结果:删除操作的状态信息
2.2 医生接口¶
2.2.1 获取医生列表¶
- 请求路径:/doctors
- 请求方法:GET
- 请求参数:无
- 返回结果:医生列表的 JSON 数组
2.2.2 获取特定医生信息¶
- 请求路径:/doctors/{doctorId}
- 请求方法:GET
- 请求参数:doctorId,医生的唯一标识
- 返回结果:特定医生的 JSON 对象
2.2.3 创建医生¶
- 请求路径:/doctors
- 请求方法:POST
- 请求参数:新医生的 JSON 对象
- 返回结果:新医生的 JSON 对象
2.2.4 更新医生信息¶
- 请求路径:/doctors/{doctorId}
- 请求方法:PUT
- 请求参数:doctorId,医生的唯一标识;更新后的医生信息的 JSON 对象
- 返回结果:更新后的医生的 JSON 对象
2.2.5 删除医生¶
- 请求路径:/doctors/{doctorId}
- 请求方法:DELETE
- 请求参数:doctorId,医生的唯一标识
- 返回结果:删除操作的状态信息
2.3 预约接口¶
2.3.1 获取预约列表¶
- 请求路径:/appointments
- 请求方法:GET
- 请求参数:无
- 返回结果:预约列表的 JSON 数组
2.3.2 获取特定预约信息¶
- 请求路径:/appointments/{appointmentId}
- 请求方法:GET
- 请求参数:appointmentId