添加项目README文档,包含项目简介、功能特性、环境要求、安装部署步骤、使用方法、auth.json文件说明和开发说明等内容。文档详细说明了如何部署和使用该API模拟服务,以及如何修改配置文件和Nginx设置。
旺铺授权API 模拟服务
项目简介
本项目是一个简单的PHP API模拟服务,用于模拟旺铺授权信息的获取功能。该服务会接收请求,并根据请求中的token参数动态替换响应中的token值后返回固定格式的JSON响应。
功能特性
- 固定JSON响应:基于auth.json文件返回固定格式的设备认证信息
- 动态Token替换:自动从请求URL中获取token参数并替换响应中的token值
- 跨域支持:允许所有来源的跨域请求
- Nginx伪静态支持:忽略请求路径和查询参数,确保所有请求都能正确处理
环境要求
- PHP 5.6+ 或 PHP 7.x
- Web服务器:Nginx(推荐)
- Windows 或 Linux 操作系统
安装部署
1. 下载项目文件
将以下文件放入您的Web服务器根目录或子目录:
index.php- API入口文件auth.json- 包含默认授权信息的JSON文件nginx伪静态- Nginx重写规则配置文件
2. 配置Web服务器
Nginx配置
-
打开Nginx配置文件(通常位于
nginx/conf/nginx.conf或/etc/nginx/nginx.conf) -
在
http块中的server配置中添加或修改以下内容:将所有请求重定向到index.php
location / { # 检查请求的文件或目录是否存在 if (!-e $request_filename) { # 保留查询字符串,重写所有请求到index.php rewrite ^/(.*)$ /index.php?$args last; } }
使用方法
基本使用
1,创建网站,域名写为wangpu.baison.com.cn
2,将项目文件放入网站根目录
3,配置Nginx伪静态,将所有请求重定向到index.php
4,重启Nginx服务
5,配置公司NAS的adguard,将wangpu.baison.com.cn指向服务器IP(劫持)
6,测试访问http://wangpu.baison.com.cn/api/sys/devicereg/getaccreditinfo3000j?from=1&tenantcode=0×tamp=20251125170440&token=82DBFF99-D114-4DBD-85E5-3AEE1004A857&version=3.0.3,如果返回固定的JSON响应,说明配置成功(apifox)
7,旺铺ipad链接办公室内和nas同网段wifi,DNS地址改成NAS的IP
8,旺铺打开左下角 终端注册,点击那串子token
9,授权完成
功能说明
- token替换:API会自动从请求URL中提取
token参数值,并替换auth.json中data.Token字段的值 - 固定响应结构:除token外,其他响应数据保持不变,均来自
auth.json文件 - 忽略路径:不管URL路径是什么,API都会返回相同的响应(由Nginx伪静态配置确保)
auth.json文件说明
auth.json文件包含了默认的授权信息结构,格式如下:
{
"status": "success",
"message": "3000+旺铺授权信息",
"data": {
"TenantCode": 533,
"TenantName": "名思图",
"Token": "默认Token值",
"AppId": "DA9363E9-692A-4D3C-AFD4-F28CF3113980",
"RegDate": "2023-11-29T17:04:48",
"ExpDate": "2099-11-27T17:04:48",
"Timestamp": "2024-11-24T16:58:59",
"AuditState": 0,
"AccreditCount": 0,
"Funcs": [
// 功能模块配置
]
}
}
您可以根据需要修改此文件中的默认值(除了Token字段,该字段会被请求中的token参数覆盖)。
开发说明
- 如需修改API响应的默认内容,请编辑
auth.json文件 - 如需修改API的处理逻辑,请编辑
index.php文件 - 如需调整URL重写规则,请修改Nginx配置