diff --git a/docs/zh-cn/nsq.md b/docs/zh-cn/nsq.md index af4c38765..3057abb9b 100644 --- a/docs/zh-cn/nsq.md +++ b/docs/zh-cn/nsq.md @@ -251,11 +251,13 @@ class NsqCommand extends HyperfCommand } ``` -### Http Api +### NSQD HTTP API -框架对 `Topic` 和 `Channel` 的 `Http Api` 进行了简单的封装。 +> NSQD HTTP API Refer: https://nsq.io/components/nsqd.html -比如,当你需要删除某个 `Topic` 时,可以执行以下代码: +组件对 NSQD HTTP API 进行了封装,您可以很方便的实现对 NSQD HTTP API 的调用。 + +比如,当您需要删除某个 `Topic` 时,可以执行以下代码: ```php get(Topic::class); $client->delete('hyperf.test'); ``` -框架支持以下接口 - -``` -/topic/create - create a new topic -/topic/delete - delete a topic -/topic/empty - empty a topic -/topic/pause - pause message flow for a topic -/topic/unpause - unpause message flow for a topic -/channel/create - create a new channel -/channel/delete - delete a channel -/channel/empty - empty a channel -/channel/pause - pause message flow for a channel -/channel/unpause - unpause message flow for a channel -``` +- `Hyperf\Nsq\Api\Topic` 类对应 `topic` 相关的 API; +- `Hyperf\Nsq\Api\Channle` 类对应 `channel` 相关的 API; +- `Hyperf\Nsq\Api\Api` 类对应 `ping`、`stats`、`config`、`debug` 等相关的 API; ## NSQ 协议 diff --git a/docs/zh-hk/nsq.md b/docs/zh-hk/nsq.md index 5037f71c0..75aea4711 100644 --- a/docs/zh-hk/nsq.md +++ b/docs/zh-hk/nsq.md @@ -251,6 +251,30 @@ class NsqCommand extends HyperfCommand } ``` +### NSQD HTTP API + +> NSQD HTTP API Refer: https://nsq.io/components/nsqd.html + +組件對 NSQD HTTP API 進行了封裝,您可以很方便的實現對 NSQD HTTP API 的調用。 + +比如,當您需要刪除某個 `Topic` 時,可以執行以下代碼: + +```php +get(Topic::class); + +$client->delete('hyperf.test'); +``` + +- `Hyperf\Nsq\Api\Topic` 類對應 `topic` 相關的 API; +- `Hyperf\Nsq\Api\Channle` 類對應 `channel` 相關的 API; +- `Hyperf\Nsq\Api\Api` 類對應 `ping`、`stats`、`config`、`debug` 等相關的 API; + ## NSQ 協議 > https://nsq.io/clients/tcp_protocol_spec.html diff --git a/docs/zh-tw/nsq.md b/docs/zh-tw/nsq.md index d1bf73d15..94064d164 100644 --- a/docs/zh-tw/nsq.md +++ b/docs/zh-tw/nsq.md @@ -251,6 +251,30 @@ class NsqCommand extends HyperfCommand } ``` +### NSQD HTTP API + +> NSQD HTTP API Refer: https://nsq.io/components/nsqd.html + +元件對 NSQD HTTP API 進行了封裝,您可以很方便的實現對 NSQD HTTP API 的呼叫。 + +比如,當您需要刪除某個 `Topic` 時,可以執行以下程式碼: + +```php +get(Topic::class); + +$client->delete('hyperf.test'); +``` + +- `Hyperf\Nsq\Api\Topic` 類對應 `topic` 相關的 API; +- `Hyperf\Nsq\Api\Channle` 類對應 `channel` 相關的 API; +- `Hyperf\Nsq\Api\Api` 類對應 `ping`、`stats`、`config`、`debug` 等相關的 API; + ## NSQ 協議 > https://nsq.io/clients/tcp_protocol_spec.html