105 lines
3.2 KiB
Markdown
105 lines
3.2 KiB
Markdown
# HospitalPay-Go 接口文档
|
||
|
||
欢迎使用 HospitalPay-Go Socket 服务器接口文档。本文档提供了完整的API接口说明、测试用例和快速参考。
|
||
|
||
## 📚 文档目录
|
||
|
||
### 1. [API接口文档](./API接口文档.md)
|
||
**完整的接口规范文档**
|
||
- 服务器概述和消息格式
|
||
- 详细的接口说明（6个功能接口）
|
||
- 错误码说明
|
||
- 连接管理和安全说明
|
||
- 监控指标
|
||
- 客户端示例代码（Go/Python）
|
||
- 常见问题解答
|
||
|
||
### 2. [测试用例](./测试用例.md)
|
||
**全面的测试用例文档**
|
||
- 基础功能测试（每个接口的正常和异常情况）
|
||
- 异常情况测试（连接、并发、超时）
|
||
- 性能测试（吞吐量、内存、CPU）
|
||
- 测试脚本（Go/Python）
|
||
- 测试报告模板
|
||
|
||
### 3. [快速参考](./快速参考.md)
|
||
**开发者快速查阅手册**
|
||
- 消息格式和功能码列表
|
||
- 错误码速查表
|
||
- 数据结构定义
|
||
- 快速示例
|
||
- 客户端代码模板
|
||
|
||
## 🚀 快速开始
|
||
|
||
### 服务器信息
|
||
- **协议**: TCP Socket
|
||
- **端口**: 配置文件中指定（默认8080）
|
||
- **编码**: UTF-8
|
||
- **数据格式**: JSON
|
||
|
||
### 消息格式
|
||
```
|
||
[长度(4位)][功能码(4位)][医院编码(4位)][时间戳(19位)][JSON数据]
|
||
```
|
||
|
||
### 支持的功能
|
||
| 功能码 | 功能名称 | 说明 |
|
||
|--------|----------|------|
|
||
| 0001 | 入院登记 | 病人入院时的登记处理 |
|
||
| 0002 | 消费额度查询 | 查询病人当月消费额度 |
|
||
| 0003 | 出院处理 | 病人出院时的处理 |
|
||
| 0004 | 消费记录 | 记录病人消费信息 |
|
||
| 0005 | 实时余额查询 | 查询病人实时余额 |
|
||
| 0006 | 发票同步 | 同步发票信息到系统 |
|
||
|
||
## 🔧 开发指南
|
||
|
||
### 1. 环境准备
|
||
确保服务器已启动并配置正确的端口和医院编码。
|
||
|
||
### 2. 客户端开发
|
||
参考 [API接口文档](./API接口文档.md) 中的示例代码，或使用 [快速参考](./快速参考.md) 中的代码模板。
|
||
|
||
### 3. 测试验证
|
||
使用 [测试用例](./测试用例.md) 中的测试脚本验证功能是否正常。
|
||
|
||
## 📋 示例请求
|
||
|
||
### 入院登记示例
|
||
```
|
||
请求: 00540001H0012024-01-15 10:30:00{"FCode":"3516022343"}
|
||
响应: {"ResultCode":"0000","ResultData":{"FCode":"3516022343","FName":"测试病人",...}}
|
||
```
|
||
|
||
### 消费记录示例
|
||
```
|
||
请求: 01840004H0012024-01-15 10:30:00{"FCode":"3516022343","InvoiceNo":"INV001",...}
|
||
响应: {"ResultCode":"0000","ResultMsg":"消费记录保存成功"}
|
||
```
|
||
|
||
## ⚠️ 重要提醒
|
||
|
||
1. **医院编码验证**: 所有请求必须包含正确的医院编码
|
||
2. **消息格式**: 严格按照指定格式构造消息
|
||
3. **超时控制**: 注意连接和处理超时时间
|
||
4. **错误处理**: 根据错误码进行相应的错误处理
|
||
|
||
## 🐛 问题反馈
|
||
|
||
如果在使用过程中遇到问题：
|
||
|
||
1. 首先查阅 [API接口文档](./API接口文档.md) 中的"常见问题"部分
|
||
2. 使用 [测试用例](./测试用例.md) 中的测试脚本进行验证
|
||
3. 检查服务器日志和网络连接
|
||
4. 联系开发团队获取支持
|
||
|
||
## 📖 文档版本
|
||
|
||
| 版本 | 日期 | 说明 |
|
||
|------|------|------|
|
||
| 1.0.0 | 2024-01-15 | 初始版本，包含6个基础功能接口 |
|
||
|
||
---
|
||
|
||
**注意**: 本文档基于当前代码版本生成，如有更新请及时同步文档内容。 |