diff --git a/README.md b/README.md index d2dcd94de950213cac36ca40b20ca99bef9e2121..35e31732c36d860a700a8c4ac981d1c385d1254e 100644 --- a/README.md +++ b/README.md @@ -38,12 +38,38 @@ go install \ https://github.com/bufbuild/buf?tab=readme-ov-file -### Protobuf-Code generieren +### Proto Dateien anpassen + +Die *.proto Dateien, die die verwendetetn GRPC Apis des Proxys definieren müssen aus den entsprechenden Projekten +in das Verzeichnis api/proto kopiert werden. + +Die Projekte sind: + +* [Collaboration-Manager](https://git.ozg-sh.de/ozgcloud-app/collaboration-manager/src/branch/master/collaboration-manager-interface/src/main/protobuf) +* [Zufi-Manager](https://git.ozg-sh.de/ozgcloud-app/zufi-manager/src/branch/master/zufi-manager-interface/src/main/protobuf) + +Damit die Code generierung funktioniert müssen die proto-Dateien aktuell noch angepasst werden. +Dazu muss in jede Datei die Zeile ```option go_package = "de.ozgcloud.fachstellenproxy";``` hinzugefügt werden, damit +die erzeugten Quellcode-Dateien im selben go package liegen. + +### Generierung konfigurieren + +Die Generierung des Gateways kann mit den Dateien + +* api/gateway-config.yml - go Code für den Gateway +* api/openapi-config.yml - für die Erzeugung der swagger json Dateien + +konfiguriert werden. + +### Protobuf-Code und swagger datei generieren ``` buf generate ``` +Erzeugt dann den Code für das Gateway und auch die Datei gen/openapiv2/fachstelleregistration.swagger.json. +Diese Datei kann dann in anderen Projekten verwendet werden um die nötige DTO Klassen zu erzeugen. + ### Anwendung starten ```