Pub/sub API 参考文档

将消息发布到给定主题

此端点允许您将数据发布到正在监听 topic 的多个消费者。 Dapr 保证此端点的至少一次（At-Least-Once ）语义。

HTTP 请求

POST http://localhost:<daprPort>/v1.0/publish/<pubsubname>/<topic>[?<metadata>]

HTTP 响应码

URL 参数

注意：所有的 URL 参数都是大小写敏感的。

curl -X POST http://localhost:3500/v1.0/publish/pubsubName/deathStarStatus \
  -H "Content-Type: application/json" \
 -d '{
       "status": "completed"
     }'

Headers

Content-Type 标头告诉 Dapr 在构建 CloudEvent 信封时，您的数据遵循哪种内容类型。 Content-Type 标头值在填充 CloudEvent 中的 datacontenttype 字段。

不指定情况下， Dapr 内容类型为 text/plain。 如果内容类型为 JSON，请使用值为 application/json的 Content-Type 标头。

如果要发送自己的自定义 CloundEvent，请使用 application/cloudevents+json 作为 Content-Type 标头值。

元数据

元数据可以通过请求 URL 中的查询参数发送。 必须以 metadata. 为前缀，如下所示。

其他元数据参数基于每个 pubsub 组件都是可用的。

可选应用程序（用户代码）路由

为 Dapr 提供发现 topic 订阅的路由

Dapr 将在用户代码上调用以下端点以发现 topic 订阅：

HTTP 请求

GET http://localhost:<appPort>/dapr/subscribe

URL 参数

HTTP 响应正文

一个 json 编码的字符串数组。

示例:

[
  {
    "pubsubname": "pubsub",
    "topic": "newOrder",
    "route": "/orders",
    "metadata": {
      "rawPayload": "true",
    }
  }
]

请注意，所有订阅参数都是大小写敏感的。

元数据

（可选）元数据可以通过请求正文发送。

为 Dapr 提供发布 topic 事件的路由

为了发布 topic 事件，将使用订阅响应中指定的路由对用户代码进行 POST 调用。

下面的例子说明了这一点，考虑 topic 为 newOrder，路由为 orders，端口为 3000 的订阅： POST http://localhost:3000/orders

HTTP 请求

POST http://localhost:<appPort>/<path>

注意：所有的 URL 参数都是大小写敏感的。

URL 参数

预期的 HTTP 响应

HTTP 2xx 响应表示消息处理成功。

对于更丰富的响应处理，可以发送具有处理状态的 JSON 编码有效负载正文：

{
  "status": "<status>"
}

Dapr 假定没有 status 字段的JSON编码的有效载荷响应或带有HTTP 2xx的空有效载荷响应为SUCCESS。

HTTP 响应可能与 HTTP 2xx 不同。 以下是 Dapr 在不同 HTTP 状态下的行为：

消息信封

Dapr Pub/Sub 遵循 CloudEvents 1.0 版。

相关链接

• 如何发布和消费主题
• 发布/订阅示例