Download the PHP package hyperf-apex/apidoc-apifox without Composer
On this page you can find all versions of the php package hyperf-apex/apidoc-apifox. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Please rate this library. Is it a good library?
Informations about the package apidoc-apifox
hyperf-apex/apidoc-apifox
把 #[WsGateway] / #[WsRoute] 声明渲染成 Apifox 原生 webSocketCollection,让长连接协议也能进接口管理平台。
- 依赖:
hyperf-apex/apidoc、hyperf-apex/websocket(安装本包会一并引入) - 完整文档:见主仓库 hyperf-apex
- 变更记录:见主仓库 CHANGELOG.md
安装
命令与出口
| 项 | 值 |
|---|---|
| 产物 | 与 OpenAPI 共用 api_doc.output_path 下的 apifox.json(默认 BASE_PATH/runtime/api-doc) |
| 出口 | GET /api_doc/get_apifox(未生成时回 404 并提示该跑哪条命令) |
配置项
| 键 | 说明 |
|---|---|
apifox.folder |
导入 Apifox 后的默认目录名 |
apifox.status |
接口状态(如 developing) |
apifox.tags |
附带的标签列表 |
契约来源
文档内容完全由 websocket 包的声明推导,不在本包里手写:
| 来源 | 渲染成 |
|---|---|
#[WsGateway(path:, endpoint:, name:)] |
一个 WebSocket 连接(含地址与说明) |
#[WsRoute('{domain}.{action}')] 及其 payload / 返回 DTO |
该连接下的各条消息(请求与响应示例) |
WsBuiltinEvent |
内置事件(sys.ping / sys.pong / sys.subscribe / sys.unsubscribe / sys.error) |
处理器上标了「测试探针」之类的内部事件不会被渲染进对外契约 —— 文档只反映真实的协议面。
All versions of apidoc-apifox with dependencies
PHP Build Version
Package Version
Requires
php Version
>=8.4
hyperf-apex/core Version ^0.1
hyperf-apex/apidoc Version ^0.1
hyperf-apex/websocket Version ^0.1
hyperf-apex/core Version ^0.1
hyperf-apex/apidoc Version ^0.1
hyperf-apex/websocket Version ^0.1
The package hyperf-apex/apidoc-apifox contains the following files
Loading the files please wait ...