HTTP 绑定规范

HTTP 绑定规范

HTTP 绑定组件的详细文档

设置 Dapr 组件

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: <NAME>
  namespace: <NAMESPACE>
spec:
  type: bindings.http
  version: v1
  metadata:
  - name: url
    value: http://something.com

Spec metadata fields

字段	Required	Binding support	Details	Example
url	Y	Output	The base URL of the HTTP endpoint to invoke	`http://host:port/path`, `http://myservice:8000/customers`

Output bindings

This component supports output binding with the folowing HTTP methods/verbs:

create : For backward compatability and treated like a post
get : Read data/records
head : Identical to get except that the server does not return a response body
post : Typically used to create records or send commands
put : Update data/records
patch : Sometimes used to update a subset of fields of a record
delete : Delete a data/record
options : Requests for information about the communication options available (not commonly used)
trace : Used to invoke a remote, application-layer loop- back of the request message (not commonly used)

Request

Operation metadata fields

All of the operations above support the following metadata fields

Field	Required	Details	Example
path	N	The path to append to the base URL. Used for accessing specific URIs	`“/1234”`, `“/search?lastName=Jones”`
Headers*	N	Any fields that have a capital first letter are sent as request headers	`“Content-Type”`, `“Accept”`

Retrieving data

To retrieve data from the HTTP endpoint, invoke the HTTP binding with a GET method and the following JSON body:

{
  "operation": "get"
}

Optionally, a path can be specified to interact with resource URIs:

{
  "operation": "get",
  "metadata": {
    "path": "/things/1234"
  }
}

Response

The response body contains the data returned by the HTTP endpoint. The data field contains the HTTP response body as a byte slice (Base64 encoded via curl). The metadata field contains:

Field	Required	Details	Example
statusCode	Y	The HTTP status code	`200`, `404`, `503`
status	Y	The status description	`“200 OK”`, `“201 Created”`
Headers*	N	Any fields that have a capital first letter are sent as request headers	`“Content-Type”`

Example:

Requesting the base URL

Windows
Linux

curl -d "{ \"operation\": \"get\" }" \
      http://localhost:<dapr-port>/v1.0/bindings/<binding-name>

curl -d '{ "operation": "get" }' \
      http://localhost:<dapr-port>/v1.0/bindings/<binding-name>

Requesting a specific path

Windows
Linux

curl -d "{ \"operation\": \"get\", \"metadata\": { \"path\": \"/things/1234\" } }" \
      http://localhost:<dapr-port>/v1.0/bindings/<binding-name>

curl -d '{ "operation": "get", "metadata": { "path": "/things/1234" } }' \
      http://localhost:<dapr-port>/v1.0/bindings/<binding-name>

Sending and updating data

To send data to the HTTP endpoint, invoke the HTTP binding with a POST, PUT, or PATCH method and the following JSON body:

Note

Any metadata field that starts with a capital letter is passed as a request header. For example, the default content type is application/json; charset=utf-8. This can be overriden be setting the Content-Type metadata field.

{
  "operation": "post",
  "data": "content (default is JSON)",
  "metadata": {
    "path": "/things",
    "Content-Type": "application/json; charset=utf-8"
  }
}

例子

Posting a new record

Windows
Linux

curl -d "{ \"operation\": \"post\", \"data\": \"YOUR_BASE_64_CONTENT\", \"metadata\": { \"path\": \"/things\" } }" \
      http://localhost:<dapr-port>/v1.0/bindings/<binding-name>

curl -d '{ "operation": "post", "data": "YOUR_BASE_64_CONTENT", "metadata": { "path": "/things" } }' \
      http://localhost:<dapr-port>/v1.0/bindings/<binding-name>

HTTP