adolforeyna/EMI-Backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add API documentation access instructions to README

Browse Source 
Updated the README.md file to include instructions on how to access the
interactive API documentation via Swagger UI, including the URL.
This commit is contained in:
Adolfo Reyna
2025-07-17 10:00:31 -04:00
parent d21736d52c
commit e4bac717f9
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -31,6 +31,14 @@ A step by step series of examples that tell you how to get a development env run
npm start 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 ## 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. The API is divided into several sections based on functionality. Most routes under `/user`, `/post`, `/bible`, and `/songs` require authentication via a session cookie.