Skip to content

pubsub_api.md

Latest commit

 

History

History
88 lines (57 loc) · 1.68 KB

pubsub_api.md

File metadata and controls

88 lines (57 loc) · 1.68 KB

Pub Sub

Publish a message to a given topic

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

HTTP Request

POST http://localhost:<daprPort>/v1.0/publish/<topic>

HTTP Response codes

Code Description
200 Message delivered
500 Delivery failed

URL Parameters

Parameter Description
daprPort the Dapr port
topic the name of the topic 
curl -X POST http://localhost:3500/v1.0/publish/deathStarStatus \
  -H "Content-Type: application/json" \
 -d '{
       "status": "completed"
     }'

Required 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 Request

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

URL Parameters

Parameter Description
appPort the application port

HTTP Response body

A json encoded array of strings.

Example:

"["TopicA","TopicB"]"

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 name of the topic as the URL path.

The following example illustrates this point, considering a subscription for topic TopicA:

HTTP Request

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

URL Parameters

Parameter Description
appPort the application port

HTTP Response body

A JSON encoded payload.

Message Envelope

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