diff --git a/README.md b/README.md index d0c81226520f79cd2efcf63f8c63d9aea0224c85..43e75cb68c2b8a8a3d3f2366fd5f037168da4eca 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ https://github.com/bufbuild/buf?tab=readme-ov-file ### Proto Dateien anpassen -Die *.proto Dateien, die die verwendetetn GRPC Apis des Proxys definieren müssen aus den entsprechenden Projekten +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: @@ -47,7 +47,16 @@ Damit die Code generierung funktioniert müssen die proto-Dateien aktuell noch a 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 +### 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