diff --git a/README.md b/README.md index 42b5fb5b64ccd7e2e53fe8e09d75a17adfd0fe9a..d0c81226520f79cd2efcf63f8c63d9aea0224c85 100644 --- a/README.md +++ b/README.md @@ -33,24 +33,42 @@ 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: + +* [VorgangManager](https://git.ozg-sh.de/ozgcloud-app/vorgang-manager/src/branch/master/vorgang-manager-interface/src/main/protobuf) +* [NachrichtenManager](https://git.ozg-sh.de/ozgcloud-app/nachrichten-manager/src/branch/master/nachrichten-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.antragraumproxy";``` hinzugefügt werden, damit +die erzeugten Quellcode-Dateien im selben go package liegen. + +### Protobuf-Code und swagger datei generieren ``` buf generate ``` +Erzeugt dann den Code für das Gateway und auch die Datei gen/openapiv2/openapiv2.swagger.json. +Diese Datei kann dann in anderen Projekten verwendet werden um die nötige DTO Klassen zu erzeugen. + ### Anwendung starten ``` ACTIVE_PROFILE=local go run cmd/antragsraum-proxy/main.go ``` -## Config +## Config + config.yml is the default config for deployment [Config-Datei](./config/config.yml) -config-local.yml is the config file for local development +config-local.yml is the config file for local development setting ACTIVE_PROFILE=local will load the config-local.yml [Config-Datei](./config/config-local.yml)