From 78445eaca6e175676b69b47e13dc094b16edaf9f Mon Sep 17 00:00:00 2001 From: Avinash Sridhar Date: Wed, 23 Apr 2025 23:38:31 -0400 Subject: [PATCH] Add API documentation section with Swagger UI access details --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index d18b8c9..ac69b03 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,16 @@ The fake service is useful for: - Testing API integrations - Example data structure reference +## API Documentation + +The API is documented using Swagger/OpenAPI. You can access the interactive Swagger UI at: + +``` +/v0/swagger/index.html +``` + +This provides a complete reference of all endpoints with request/response schemas and allows you to test the API directly from your browser. + ## API Endpoints ### Health Check