API清单.md 24 KB
萤火商城接口清单（Java 重写对齐基线）
自动扫描自
F:\shop\shop（ThinkPHP 6 多应用路由：/模块/控制器/方法，多级控制器用点号连接）。响应统一为{"status":200,"message":"success","data":{...}}。
接口总数：253
模块 admin（24 个接口）
Controller（app/admin/controller/Controller.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| initialize | /admin/controller/initialize |
— | — |
Passport（app/admin/controller/Passport.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| login | /admin/passport/login |
— | — |
| logout | /admin/passport/logout |
— | — |
Store（app/admin/controller/Store.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| index | /admin/store/index |
— | — |
| add | /admin/store/add |
— | — |
| recycle | /admin/store/recycle |
— | — |
| recovery | /admin/store/recovery |
int $storeId | — |
| edit | /admin/store/edit |
int $storeId | — |
| move | /admin/store/move |
int $storeId | — |
User（app/admin/controller/admin/User.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| detail | /admin/admin.user/detail |
— | — |
| renew | /admin/admin.user/renew |
— | — |
Cache（app/admin/controller/setting/Cache.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| clear | /admin/setting.cache/clear |
— | — |
Science（app/admin/controller/setting/Science.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| info | /admin/setting.science/info |
— | — |
Timer（app/admin/controller/setting/Timer.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| test | /admin/setting.timer/test |
— | — |
Api（app/admin/controller/store/Api.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| index | /admin/store.api/index |
— | — |
| add | /admin/store.api/add |
— | — |
| edit | /admin/store.api/edit |
int $apiId | — |
| delete | /admin/store.api/delete |
int $apiId | — |
Menu（app/admin/controller/store/Menu.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| index | /admin/store.menu/index |
— | — |
| info | /admin/store.menu/info |
int $menuId | — |
| add | /admin/store.menu/add |
— | — |
| edit | /admin/store.menu/edit |
int $menuId | — |
| setApis | /admin/store.menu/set_apis |
int $menuId | — |
| delete | /admin/store.menu/delete |
int $menuId | — |
模块 api（74 个接口）
Address（app/api/controller/Address.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/address/list |
— | — |
| defaultId | /api/address/default_id |
— | — |
| detail | /api/address/detail |
int $addressId | — |
| add | /api/address/add |
— | — |
| edit | /api/address/edit |
int $addressId | — |
| setDefault | /api/address/set_default |
int $addressId | — |
| remove | /api/address/remove |
int $addressId | — |
Article（app/api/controller/Article.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/article/list |
int $categoryId = 0 | — |
| detail | /api/article/detail |
int $articleId | — |
Captcha（app/api/controller/Captcha.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| image | /api/captcha/image |
— | — |
| sendSmsCaptcha | /api/captcha/send_sms_captcha |
— | — |
Cart（app/api/controller/Cart.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/cart/list |
— | — |
| total | /api/cart/total |
— | — |
| add | /api/cart/add |
int $goodsId, string $goodsSkuId, int $goodsNum | — |
| update | /api/cart/update |
int $goodsId, string $goodsSkuId, int $goodsNum | — |
| clear | /api/cart/clear |
array $cartIds = [] | — |
Cashier（app/api/controller/Cashier.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| orderInfo | /api/cashier/order_info |
int $orderId, string $client | — |
| orderPay | /api/cashier/order_pay |
int $orderId, string $method, string $client, array $extra = [] | — |
| tradeQuery | /api/cashier/trade_query |
string $outTradeNo, string $method, string $client | — |
Category（app/api/controller/Category.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/category/list |
— | — |
Checkout（app/api/controller/Checkout.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| order | /api/checkout/order |
string $mode = 'buyNow' | — |
| submit | /api/checkout/submit |
string $mode = 'buyNow' | — |
Comment（app/api/controller/Comment.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/comment/list |
int $goodsId, int $scoreType = null | — |
| total | /api/comment/total |
int $goodsId | — |
| listRows | /api/comment/list_rows |
int $goodsId, int $limit = 5 | — |
Coupon（app/api/controller/Coupon.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/coupon/list |
— | — |
Express（app/api/controller/Express.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/express/list |
— | — |
Goods（app/api/controller/Goods.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/goods/list |
— | — |
| detail | /api/goods/detail |
int $goodsId, bool $verifyStatus = true | — |
| basic | /api/goods/basic |
int $goodsId, bool $verifyStatus = true | — |
| specData | /api/goods/spec_data |
int $goodsId | — |
| skuInfo | /api/goods/sku_info |
int $goodsId, string $goodsSkuId | — |
Help（app/api/controller/Help.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/help/list |
— | — |
Index（app/api/controller/Index.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| index | /api/index/index |
— | — |
MyCoupon（app/api/controller/MyCoupon.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/my_coupon/list |
— | — |
| receive | /api/my_coupon/receive |
int $couponId | — |
Notify（app/api/controller/Notify.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| wechatV2 | /api/notify/wechat_v2 |
— | — |
| wechatV3 | /api/notify/wechat_v3 |
— | — |
| alipay | /api/notify/alipay |
— | — |
Order（app/api/controller/Order.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/order/list |
string $dataType | — |
| detail | /api/order/detail |
int $orderId | — |
| express | /api/order/express |
int $orderId | — |
| cancel | /api/order/cancel |
int $orderId | — |
| receipt | /api/order/receipt |
int $orderId | — |
| todoCounts | /api/order/todo_counts |
— | — |
Page（app/api/controller/Page.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| detail | /api/page/detail |
int $pageId = null | — |
Passport（app/api/controller/Passport.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| login | /api/passport/login |
— | — |
| loginMpWx | /api/passport/login_mp_wx |
— | — |
| loginMpWxMobile | /api/passport/login_mp_wx_mobile |
— | — |
| isPersonalMpweixin | /api/passport/is_personal_mpweixin |
string $code | — |
Recharge（app/api/controller/Recharge.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| center | /api/recharge/center |
string $client | — |
| submit | /api/recharge/submit |
— | — |
| tradeQuery | /api/recharge/trade_query |
string $outTradeNo, string $method, string $client | — |
Refund（app/api/controller/Refund.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/refund/list |
int $state = -1 | — |
| goods | /api/refund/goods |
int $orderGoodsId | — |
| apply | /api/refund/apply |
int $orderGoodsId | — |
| detail | /api/refund/detail |
int $orderRefundId | — |
| delivery | /api/refund/delivery |
int $orderRefundId | — |
Region（app/api/controller/Region.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| all | /api/region/all |
— | — |
| tree | /api/region/tree |
— | — |
Setting（app/api/controller/Setting.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| data | /api/setting/data |
— | — |
Store（app/api/controller/Store.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| data | /api/store/data |
— | — |
Upload（app/api/controller/Upload.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| image | /api/upload/image |
bool $checkLogin = true | — |
User（app/api/controller/User.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| info | /api/user/info |
— | — |
| assets | /api/user/assets |
— | — |
| bindMobile | /api/user/bind_mobile |
— | — |
| personal | /api/user/personal |
— | — |
Category（app/api/controller/article/Category.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/article.category/list |
— | — |
Log（app/api/controller/balance/Log.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/balance.log/list |
— | — |
Service（app/api/controller/goods/Service.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/goods.service/list |
int $goodsId | — |
Comment（app/api/controller/order/Comment.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/order.comment/list |
int $orderId | — |
| submit | /api/order.comment/submit |
int $orderId | — |
Log（app/api/controller/points/Log.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/points.log/list |
— | — |
Order（app/api/controller/recharge/Order.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /api/recharge.order/list |
— | — |
模块 store（151 个接口）
Category（app/store/controller/Category.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/category/list |
— | — |
| delete | /store/category/delete |
int $categoryId | — |
| add | /store/category/add |
— | — |
| edit | /store/category/edit |
int $categoryId | — |
Controller（app/store/controller/Controller.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| initialize | /store/controller/initialize |
— | — |
Files（app/store/controller/Files.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/files/list |
— | — |
| edit | /store/files/edit |
int $fileId | — |
| delete | /store/files/delete |
array $fileIds | — |
| moveGroup | /store/files/move_group |
int $groupId, array $fileIds | — |
Goods（app/store/controller/Goods.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/goods/list |
— | — |
| listByIds | /store/goods/list_by_ids |
array $goodsIds | — |
| detail | /store/goods/detail |
int $goodsId | — |
| basic | /store/goods/basic |
int $goodsId | — |
| add | /store/goods/add |
— | — |
| edit | /store/goods/edit |
int $goodsId | — |
| state | /store/goods/state |
array $goodsIds, bool $state | — |
| delete | /store/goods/delete |
array $goodsIds | — |
Home（app/store/controller/Home.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| data | /store/home/data |
— | — |
Order（app/store/controller/Order.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/order/list |
string $dataType | — |
| detail | /store/order/detail |
int $orderId | — |
Page（app/store/controller/Page.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/page/list |
— | — |
| defaultData | /store/page/default_data |
— | — |
| detail | /store/page/detail |
int $pageId | — |
| add | /store/page/add |
— | — |
| edit | /store/page/edit |
int $pageId | — |
| delete | /store/page/delete |
int $pageId | — |
| setHome | /store/page/set_home |
int $pageId | — |
Passport（app/store/controller/Passport.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| login | /store/passport/login |
— | — |
| logout | /store/passport/logout |
— | — |
Region（app/store/controller/Region.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| all | /store/region/all |
— | — |
| tree | /store/region/tree |
— | — |
Setting（app/store/controller/Setting.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| detail | /store/setting/detail |
string $key | — |
| update | /store/setting/update |
string $key | — |
Store（app/store/controller/Store.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| info | /store/store/info |
— | — |
| update | /store/store/update |
— | — |
Upload（app/store/controller/Upload.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| image | /store/upload/image |
int $groupId = 0 | — |
| video | /store/upload/video |
int $groupId = 0 | — |
User（app/store/controller/User.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/user/list |
— | — |
| delete | /store/user/delete |
int $userId | — |
| recharge | /store/user/recharge |
int $userId, string $target | — |
| grade | /store/user/grade |
int $userId | — |
Setting（app/store/controller/client/h5/Setting.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| detail | /store/client.h5.setting/detail |
string $key | — |
| update | /store/client.h5.setting/update |
string $key | — |
Setting（app/store/controller/client/wxapp/Setting.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| detail | /store/client.wxapp.setting/detail |
string $key | — |
| update | /store/client.wxapp.setting/update |
string $key | — |
Article（app/store/controller/content/Article.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/content.article/list |
— | — |
| detail | /store/content.article/detail |
int $articleId | — |
| add | /store/content.article/add |
— | — |
| edit | /store/content.article/edit |
int $articleId | — |
| delete | /store/content.article/delete |
int $articleId | — |
Help（app/store/controller/content/Help.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/content.help/list |
— | — |
| add | /store/content.help/add |
— | — |
| edit | /store/content.help/edit |
int $helpId | — |
| delete | /store/content.help/delete |
int $helpId | — |
Category（app/store/controller/content/article/Category.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/content.article.category/list |
— | — |
| add | /store/content.article.category/add |
— | — |
| edit | /store/content.article.category/edit |
int $categoryId | — |
| delete | /store/content.article.category/delete |
int $categoryId | — |
Group（app/store/controller/files/Group.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/files.group/list |
— | — |
| add | /store/files.group/add |
— | — |
| edit | /store/files.group/edit |
int $groupId | — |
| delete | /store/files.group/delete |
int $groupId | — |
Comment（app/store/controller/goods/Comment.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/goods.comment/list |
— | — |
| detail | /store/goods.comment/detail |
int $commentId | — |
| edit | /store/goods.comment/edit |
int $commentId | — |
| delete | /store/goods.comment/delete |
int $commentId | — |
Service（app/store/controller/goods/Service.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/goods.service/list |
— | — |
| all | /store/goods.service/all |
— | — |
| add | /store/goods.service/add |
— | — |
| edit | /store/goods.service/edit |
int $serviceId | — |
| delete | /store/goods.service/delete |
int $serviceId | — |
Spec（app/store/controller/goods/Spec.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/goods.spec/list |
int $goodsId | — |
Coupon（app/store/controller/market/Coupon.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/market.coupon/list |
— | — |
| detail | /store/market.coupon/detail |
int $couponId | — |
| add | /store/market.coupon/add |
— | — |
| edit | /store/market.coupon/edit |
int $couponId | — |
| delete | /store/market.coupon/delete |
int $couponId | — |
| receive | /store/market.coupon/receive |
— | — |
Points（app/store/controller/market/Points.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| log | /store/market.points/log |
— | — |
Plan（app/store/controller/market/recharge/Plan.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/market.recharge.plan/list |
— | — |
| add | /store/market.recharge.plan/add |
— | — |
| edit | /store/market.recharge.plan/edit |
int $planId | — |
| delete | /store/market.recharge.plan/delete |
int $planId | — |
Delivery（app/store/controller/order/Delivery.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/order.delivery/list |
— | — |
| detail | /store/order.delivery/detail |
int $deliveryId | — |
| delivery | /store/order.delivery/delivery |
int $orderId | — |
| traces | /store/order.delivery/traces |
int $deliveryId | — |
Event（app/store/controller/order/Event.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| updatePrice | /store/order.event/update_price |
int $orderId | — |
| updateRemark | /store/order.event/update_remark |
int $orderId | — |
| updateAddress | /store/order.event/update_address |
int $orderId | — |
| printer | /store/order.event/printer |
int $orderId | — |
| confirmCancel | /store/order.event/confirm_cancel |
$orderId | — |
| delete | /store/order.event/delete |
int $orderId | — |
Export（app/store/controller/order/Export.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| exportOrder | /store/order.export/export_order |
— | — |
| list | /store/order.export/list |
— | — |
Refund（app/store/controller/order/Refund.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/order.refund/list |
— | — |
| detail | /store/order.refund/detail |
int $orderRefundId | — |
| audit | /store/order.refund/audit |
int $orderRefundId | — |
| receipt | /store/order.refund/receipt |
int $orderRefundId | — |
Cache（app/store/controller/setting/Cache.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| items | /store/setting.cache/items |
— | — |
| clear | /store/setting.cache/clear |
— | — |
Delivery（app/store/controller/setting/Delivery.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/setting.delivery/list |
— | — |
| all | /store/setting.delivery/all |
— | — |
| detail | /store/setting.delivery/detail |
int $deliveryId | — |
| add | /store/setting.delivery/add |
— | — |
| edit | /store/setting.delivery/edit |
int $deliveryId | — |
| delete | /store/setting.delivery/delete |
int $deliveryId | — |
Express（app/store/controller/setting/Express.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/setting.express/list |
— | — |
| all | /store/setting.express/all |
— | — |
| delete | /store/setting.express/delete |
int $expressId | — |
| add | /store/setting.express/add |
— | — |
| edit | /store/setting.express/edit |
int $expressId | — |
Payment（app/store/controller/setting/Payment.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| options | /store/setting.payment/options |
— | — |
| update | /store/setting.payment/update |
— | — |
Printer（app/store/controller/setting/Printer.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/setting.printer/list |
— | — |
| all | /store/setting.printer/all |
— | — |
| add | /store/setting.printer/add |
— | — |
| edit | /store/setting.printer/edit |
int $printerId | — |
| delete | /store/setting.printer/delete |
int $printerId | — |
Template（app/store/controller/setting/payment/Template.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/setting.payment.template/list |
— | — |
| all | /store/setting.payment.template/all |
— | — |
| detail | /store/setting.payment.template/detail |
int $templateId | — |
| add | /store/setting.payment.template/add |
— | — |
| edit | /store/setting.payment.template/edit |
int $templateId | — |
| delete | /store/setting.payment.template/delete |
int $templateId | — |
Data（app/store/controller/statistics/Data.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| initialize | /store/statistics.data/initialize |
— | — |
| data | /store/statistics.data/data |
— | — |
| survey | /store/statistics.data/survey |
$startDate = null, $endDate = null | — |
Address（app/store/controller/store/Address.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/store.address/list |
— | — |
| all | /store/store.address/all |
— | — |
| add | /store/store.address/add |
— | — |
| edit | /store/store.address/edit |
int $addressId | — |
| delete | /store/store.address/delete |
int $addressId | — |
Menu（app/store/controller/store/Menu.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/store.menu/list |
— | — |
Role（app/store/controller/store/Role.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/store.role/list |
— | — |
| add | /store/store.role/add |
— | — |
| edit | /store/store.role/edit |
int $roleId | — |
| delete | /store/store.role/delete |
int $roleId | — |
User（app/store/controller/store/User.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| info | /store/store.user/info |
— | — |
| list | /store/store.user/list |
— | — |
| add | /store/store.user/add |
— | — |
| edit | /store/store.user/edit |
int $userId | — |
| delete | /store/store.user/delete |
int $userId | — |
| renew | /store/store.user/renew |
— | — |
Balance（app/store/controller/user/Balance.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| log | /store/user.balance/log |
— | — |
Grade（app/store/controller/user/Grade.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| list | /store/user.grade/list |
— | — |
| all | /store/user.grade/all |
— | — |
| add | /store/user.grade/add |
— | — |
| edit | /store/user.grade/edit |
int $gradeId | — |
| delete | /store/user.grade/delete |
int $gradeId | — |
Recharge（app/store/controller/user/Recharge.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| order | /store/user.recharge/order |
— | — |
模块 timer（4 个接口）
Order（app/timer/controller/Order.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| handle | /timer/order/handle |
array $param | — |
Store（app/timer/controller/Store.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| handle | /timer/store/handle |
— | — |
UserCoupon（app/timer/controller/UserCoupon.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| handle | /timer/user_coupon/handle |
array $param | — |
UserGrade（app/timer/controller/UserGrade.php）
| 方法 | URL | 参数 | 说明 |
|---|---|---|---|
| handle | /timer/user_grade/handle |
array $param | — |