dapr / dapr/cpp-sdk

doc: add diagram for how CPP SDK interacts with Dapr runtime

Offen
#56 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Makefile
Sterne
38
Forks
16
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

## Describe the proposal

**Is your feature request related to a problem? Please describe.**
There is no visual representation for how the SDK interacts with the Dapr runtime.

**Describe the solution you'd like**
It would be nice for community members to have a diagram depicting the interactions with end user applications, the Dapr CPP SDK, and the Dapr sidecar close to the codebase, within the README.md file.

The diagram should include:

- 3 main components: end user application, Dapr CPP SDK, Dapr sidecar:
- Initialization: which protocol is the application Dapr client using to establish connection with the Dapr sidecar, HTTP or gRPC? That depends on the SDK and should be depicted visually.
- API calls that one can use the Dapr client for. For example you can save & retrieve state from state stores, publish and subscribe to events using pub/sub, invoke other services using service invocation, etc. We should represent which APIs the SDK supports.
- Overall request routing (when app makes API call through Dapr client, then the request is sent to the Dapr sidecar running along the app)

Other ideas that can be included in diagram:

- Sidecar processing
- Response handling
- Middleware and observability
- Error handling
- Security

**Describe alternatives you've considered**
We could technically keep the README.md file as is, but it would be nice to have visuals here for community members understanding of these interactions.

**Additional context**
https://docs.dapr.io/developing-applications/sdks/

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne mit README.md und der verlinkten Dapr SDK-Dokumentation, um die vom C++ SDK unterstützten Protokolle und APIs zu verstehen. Erstelle ein Diagramm, das die Endbenutzeranwendung, das Dapr C++ SDK und den Dapr sidecar zeigt, einschließlich Initialisierung, Request-Routing sowie Interaktionen mit State, pub/sub und service-invocation. Als erledigt gilt die Aufgabe, wenn das Diagramm in der Nähe der Codebasis in README.md platziert ist und diese Abläufe korrekt widerspiegelt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
cpp
Bereich
api, documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.