Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,23 @@ This is the Dapr SDK for Java, including the following features:

## Getting Started

### Architecture Overview

The diagram below shows how a Java application interacts with the Dapr runtime through the Java SDK:

```mermaid
flowchart LR
A[End User Application] -->|HTTP or gRPC| B[Dapr Java SDK]
B -->|API calls| C[Dapr Sidecar]
C -->|State Store, Pub/Sub, Service Invocation, Bindings, Actors, Workflows| D[External Components]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be worth just saying Dapr API calls instead of listing them all out? I mention this because I notice you are missing some, and as we add more in the future we will become outdated if we list them all individually. My recommendation would be to note generally this section is the Dapr API calls and link to the available APIs from the Dapr Docs here: https://docs.dapr.io/reference/api/

C --> A
```

* The application creates a Dapr client (HTTP or gRPC).
* The SDK routes API calls (state, pub/sub, service invocation, bindings, actors, workflows).
* The Dapr sidecar manages communication with external components and returns responses to the app.


### Pre-Requisites
* SDKMAN! installed (recommended):
* [SDKMAN!](https://sdkman.io)
Expand Down Expand Up @@ -278,4 +295,4 @@ Once the project has been imported, the individual tests can be run normally as

> Sometimes when the `sdk-tests` project does not build correctly, try `File > Invalidate Caches...` and try restarting IntelliJ.

You should be able to set breakpoints and Debug the test directly from IntelliJ itself as seen from the above image.
You should be able to set breakpoints and Debug the test directly from IntelliJ itself as seen from the above image.