From ef3ed7f802f0ab677b67c6b0bf1e1a046884c91f Mon Sep 17 00:00:00 2001 From: Tamir Gershberg Date: Thu, 7 Mar 2024 11:47:11 +0200 Subject: [PATCH] update readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c19e6b2b..02b5850c 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@ The application contains: - React based web client - FE - http://localhost:8090 - BE - http://localhost:3000 -- NodeJS server - the full API documentation is available via swagger or GraphQL +- NodeJS server that serves that React client and provides both OpenAPI and GraphQL endpoints. +The full API documentation is available via swagger or GraphQL: - Swagger UI - http://localhost:8090/swagger - Swagger JSON file - http://localhost:8090/swagger-json - GraphiQL UI - http://localhost:8090/graphiql -- nginx web server that serves the client and acts as a reverse proxy for the server's API requests > **Note** > The GraphQL API does not yet support all of the endpoints the REST API does.