diff --git a/README.md b/README.md index 1108891a7d44035b107d69d7add7b42526146899..3fd338470306b726b500614feadac96766db0b95 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,28 @@ go install \ https://github.com/bufbuild/buf?tab=readme-ov-file +### Proto Dateien anpassen + +Die *.proto Dateien, die die verwendeten GRPC Apis des Proxys definieren müssen aus den entsprechenden Projekten +in das Verzeichnis api/proto kopiert werden. + +Die Projekte sind: + +* [InfoManager](https://git.ozg-sh.de/ozgcloud-app/info-manager/src/branch/master/info-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.info";``` hinzugefügt werden, damit +die erzeugten Quellcode-Dateien im selben go package liegen. + ### Protobuf-Code generieren ``` buf generate ``` +Erzeugt dann den Code für das Gateway und auch die Datei gen/openapiv2/infomanager.swagger.json. +Diese Datei kann dann in anderen Projekten verwendet werden um die nötige DTO Klassen zu erzeugen. + ### Anwendung starten ```