Edit

PlanController

PlanController 文档

PlanController 是一个Spring Boot控制器，负责管理与计划相关的操作，包括创建计划、列出场所和场馆、编辑和删除计划等功能。它通过 PlanService 来执行具体的业务逻辑。

类注解

@RestController：标记该类为一个RESTful控制器，使用此注解创建的类中的所有响应方法返回值将直接写入HTTP响应体中。 @RequestMapping("/plans")：指定该控制器处理的请求路径的前缀。

依赖注入

@Autowired：Spring的自动注入功能，将自动注入 PlanService 的实例。

接口方法

创建计划

  • 路径：/createPlan

  • 方法：POST

  • 请求体：PlanRequest，包含计划详情、场所ID和场馆ID列表。

  • 功能描述：创建一个新的计划，包括计划关联的场所和场馆。

  • 返回值：操作结果，成功时返回成功信息。

列出场所下的场馆

  • 路径：/place/{placeId}/venues

  • 方法：GET

  • 参数：

    • placeId：路径变量，指定查询的场所ID。

    • pageNum、pageSize：分页参数。

    • venueName、type：查询条件，可选。

  • 功能描述：根据场所ID列出场馆，支持分页和条件查询。

  • 返回值：操作结果，成功时返回场馆的分页列表。

列出最近的场馆

  • 路径：/place/{placeId}/{venueId}/nearestVenue

  • 方法：GET

  • 参数：

    • placeId、venueId：路径变量，分别指定场所和场馆ID。

    • venueName、type、radius：查询条件，可选，radius默认值为200。

  • 功能描述：根据场所和场馆ID列出最近的场馆，支持条件查询。

  • 返回值：操作结果，成功时返回最近场馆的列表。

列出场所

  • 路径：/places

  • 方法：GET

  • 参数：

    • pageNum、pageSize：分页参数。

    • name、address：查询条件，可选。

  • 功能描述：列出场所，支持分页和条件查询。

  • 返回值：操作结果，成功时返回场所的分页列表。

获取场所详情

  • 路径：/place/{placeId}

  • 方法：GET

  • 参数：placeId：路径变量，指定查询的场所ID。

  • 功能描述：获取指定ID的场所详情。

  • 返回值：操作结果，成功时返回场所详情。

删除计划

  • 路径：/deletePlan

  • 方法：DELETE

  • 参数：planId：请求参数，指定要删除的计划ID。

  • 功能描述：删除指定ID的计划。

  • 返回值：操作结果，成功时返回成功信息。

编辑计划

  • 路径：/editPlan/{id}

  • 方法：PUT

  • 请求体：PlanRequest，包含计划详情、场所ID和场馆ID列表。

  • 参数：id：路径变量，指定要更新的计划ID。

  • 功能描述：更新指定ID的计划，包括计划关联的场所和场馆。

  • 返回值：操作结果，成功时返回成功信息。

列出我的计划

  • 路径：/myPlans

  • 方法：GET

  • 参数：

    • pageNum、pageSize：分页参数。

    • planId、placeId、planTitle：查询条件，可选。

  • 功能描述：列出用户的计划，支持分页和条件查询。

  • 返回值：操作结果，成功时返回计划的分页列表。

内部类

PlanRequest

用于接收创建计划和编辑计划请求的数据结构。

  • 字段：

    • plan：Plan对象，包含计划的详情。

    • placeId：场所ID。

    • venueIds：场馆ID列表。

注意事项

所有接口的返回值都使用了 Result 类型，以统一响应格式，方便前端处理。 本文档描述的API接口仅为示例，实际使用时应根据具体业务需求进行调整。

PreviousMapUpdateControllerNextUserController

Last updated