springcommunity/spring-petclinic-rest

Spring Petclinic REST 镜像文档

镜像概述

Spring Petclinic REST镜像是经典Spring Petclinic示例应用的RESTful API版本，专为演示Spring框架的RESTful服务开发而设计。该镜像封装了完整的RESTful接口实现，可直接部署运行，用于展示Spring Boot、Spring Data JPA、Spring MVC等技术在RESTful API开发中的实践。

核心功能和特性

• RESTful API接口：提供宠物管理（增删改查）、兽医信息管理、预约记录管理等完整的RESTful资源接口
• Spring生态集成：基于Spring Boot构建，集成Spring Data JPA进行数据访问，支持H2内存数据库（默认）
• API标准化：遵循REST规范，支持JSON数据格式，实现标准HTTP方法（GET/POST/PUT/DELETE）
• 可观测性：集成Spring Boot Actuator，提供健康检查、指标监控等运维端点
• 代码示例价值：包含完整的RESTful服务分层架构（Controller/Service/Repository），可作为REST API设计参考

使用场景和适用范围

• 开发者学习：RESTful API设计与实现的实践案例，适合Spring框架初学者和REST服务开发者
• 技术演示：展示Spring Boot构建REST服务的最佳实践
• 教学培训：作为RESTful API开发、Spring生态集成的教学示例
• 原型开发：可作为宠物诊所类应用REST服务的基础原型

使用方法和配置说明

基本部署

通过Docker命令快速启动容器：

bash
docker run -d -p 8080:8080 --name petclinic-rest docker.xuanyuan.run/springcommunity/spring-petclinic-rest

• -p 8080:8080：将容器的8080端口映射到主机的8080端口
• --name petclinic-rest：指定容器名称为petclinic-rest
• 默认使用H2内存数据库，数据仅在容器运行期间保留

环境变量配置

支持通过环境变量调整应用配置（完整配置参见https://github.com/spring-projects/spring-petclinic-rest%EF%BC%89%EF%BC%9A

示例（使用外部MySQL数据库）：

bash
docker run -d -p 8080:8080 \
  -e SPRING_DATASOURCE_URL=jdbc:mysql://mysql-host:3306/petclinic \
  -e SPRING_DATASOURCE_USERNAME=dbuser \
  -e SPRING_DATASOURCE_PASSWORD=dbpass \
  --name petclinic-rest docker.xuanyuan.run/springcommunity/spring-petclinic-rest

访问API

服务启动后，通过以下方式访问REST API：

• API根路径：http://<主机IP>:8080/api
• 接口文档：访问http://<主机IP>:8080/swagger-ui.html查看API文档（如已集成Swagger）
• 常用API端点示例：
  • 获取所有宠物：GET /api/pets
  • 获取单个宠物：GET /api/pets/{id}
  • 创建宠物：POST /api/pets（请求体为JSON格式的宠物信息）
  • 更新宠物：PUT /api/pets/{id}
  • 删除宠物：DELETE /api/pets/{id}

数据持久化

默认使用H2内存数据库，数据在容器重启后丢失。如需持久化数据，可：

1. 挂载H2数据库文件到主机：

bash
docker run -d -p 8080:8080 \
  -v /host/path/to/h2-data:/app/h2-data \
  -e SPRING_DATASOURCE_URL=jdbc:h2:file:/app/h2-data/petclinic \
  --name petclinic-rest docker.xuanyuan.run/springcommunity/spring-petclinic-rest

2. 或配置外部数据库（如MySQL、PostgreSQL），通过SPRING_DATASOURCE_*环境变量指定连接信息

注意事项

• 该镜像主要用于学习和演示，生产环境使用前需进行安全加固和性能优化
• 默认配置未启用身份认证，实际应用中需添加Spring Security等安全机制
• 如需扩展功能，可基于镜像源码（https://github.com/spring-projects/spring-petclinic-rest%EF%BC%89%E8%BF%9B%E8%A1%8C%E4%BA%8C%E6%AC%A1%E5%BC%80%E5%8F%91