From e4bac717f9d1dc14e2cc72d22b882b774a931efc Mon Sep 17 00:00:00 2001 From: Adolfo Reyna Date: Thu, 17 Jul 2025 10:00:31 -0400 Subject: [PATCH] docs: Add API documentation access instructions to README Updated the README.md file to include instructions on how to access the interactive API documentation via Swagger UI, including the URL. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 63e0e2c..7779397 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,14 @@ A step by step series of examples that tell you how to get a development env run npm start ``` +### API Documentation + +Once the server is running, you can access the interactive API documentation powered by Swagger UI at: + +`http://localhost:3000/api-docs` + +This page allows you to view all available endpoints, their parameters, and test them directly from your browser. + ## API Endpoints The API is divided into several sections based on functionality. Most routes under `/user`, `/post`, `/bible`, and `/songs` require authentication via a session cookie.