Merge pull request #1 from scholarX-Assesment/master

docs: add initial API documentation for the API Gateway project
scholarX-Assesment · Dec 14, 2024 · 6957025 · 6957025
2 parents b22b27f + 21a59a3
commit 6957025
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/API-docs.md b/API-docs.md
@@ -0,0 +1,7 @@
+# API Documentation
+
+## Introduction
+Welcome to the API documentation for the API Gateway project. This document provides information on how to interact with the API, including authentication, available endpoints, and error handling.
+
+## Endpoints
+List the available endpoints in your API along with their descriptions, request parameters, and response formats. For example: