Pub/sub API reference

Detailed documentation on the pub/sub API

Publish a message to a given topic

This endpoint lets you publish data to multiple consumers who are listening on a topic. Dapr guarantees at least once semantics for this endpoint.

HTTP 请求

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

HTTP 响应码

代码 描述
204 Message delivered
403 Message forbidden by access controls
404 No pubsub name or topic given
500 Delivery failed

URL 参数

参数 描述
daprPort dapr 端口。
pubsubname the name of pubsub component
topic the name of the topic
metadata query parameters for metadata as described below

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

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

Headers

The Content-Type header tells Dapr which content type your data adheres to when constructing a CloudEvent envelope. The value of the Content-Type header populates the datacontenttype field in the CloudEvent. Unless specified, Dapr assumes text/plain. If your content type is JSON, use a Content-Type header with the value of application/json.

If you want to send your own custom CloundEvent, use the application/cloudevents+json value for the Content-Type header.

元数据(Metadata)

Metadata can be sent via query parameters in the request’s URL. It must be prefixed with metadata. as shown below.

参数 描述
metadata.ttlInSeconds the number of seconds for the message to expire as described here

Additional metadata parameters are available based on each pubsub component.

Optional Application (User Code) Routes

Provide a route for Dapr to discover topic subscriptions

Dapr will invoke the following endpoint on user code to discover topic subscriptions:

HTTP 请求

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

URL 参数

参数 描述
appPort 应用程序端口

HTTP Response body

A json encoded array of strings.

示例:

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

Note, all subscription parameters are case-sensitive.

Provide route(s) for Dapr to deliver topic events

In order to deliver topic events, a POST call will be made to user code with the route specified in the subscription response.

The following example illustrates this point, considering a subscription for topic newOrder with route orders on port 3000: POST http://localhost:3000/orders

HTTP 请求

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

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

URL 参数

参数 描述
appPort 应用程序端口
path route path from the subscription configuration

Expected HTTP Response

An HTTP 2xx response denotes successful processing of message. For richer response handling, a JSON encoded payload body with the processing status can be sent:

{
  "status": "<status>"
}
状态 (Status) 描述
SUCCESS message is processed successfully
RETRY message to be retried by Dapr
DROP warning is logged and message is dropped
Others error, message to be retried by Dapr

Dapr assumes a JSON encoded payload response without status field or an empty payload responses with HTTP 2xx, as SUCCESS.

The HTTP response might be different from HTTP 2xx, the following are Dapr’s behavior in different HTTP statuses:

HTTP Status 描述
2xx message is processed as per status in payload (SUCCESS if empty; ignored if invalid payload).
404 error is logged and message is dropped
other warning is logged and message to be retried

Message envelope

Dapr Pub/Sub adheres to version 1.0 of Cloud Events.

相关链接

Last modified January 1, 0001