diff --git a/README.md b/README.md index 461fea0a96dae00945a27046aa5779b277d5071a..363a291a2dd15e0099d7228d6fb35ce12b136862 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ -# Info-manager-proxy +# Info-Manager-Proxy + +Der Info-Manager-Proxy nimmt HTTP Requests vom Antragsraum-Server entgegen, mappt diese auf gRPC +und leitet sie an den Info-Manager weiter. Zum Protokollmapping von HTTP auf gRPC wird die +Bibliothek [gRPC-Gateway](https://grpc-ecosystem.github.io/grpc-gateway/) verwendet. Dadurch können die HTTP-Endpunkte inkl. des Mappings +größtenteils automatisch aus proto-Dateien generiert werden. + +Requests werden an die unter config.grpc.url eingetragene URL (bzw. localhost:50051, wenn +config.grpc.mock = true) weitergeleitet. ## Getting Started