[PR #5] [MERGED] feat: Add Swagger and Postman support #5

New issue

Closed

opened 2026-03-03 01:17:13 +03:00 by kerem · 0 comments

kerem commented

2026-03-03 01:17:13 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Codegres-com/Simple-Whatsapp-API/pull/5
Author: @Codegres-com
Created: 9/30/2025
Status: ✅ Merged
Merged: 9/30/2025
Merged by: @Codegres-com

Base: main ← Head: feature/swagger-postman-docs

📝 Commits (1)

970343d feat: Add Swagger and Postman support

📊 Changes

8 files changed (+728 additions, -4 deletions)

View changed files

📝 README.md (+22 -0)
📝 package-lock.json (+271 -0)
📝 package.json (+2 -0)
➕ server.log (+4 -0)
📝 src/index.js (+25 -0)
📝 src/routes/api.js (+148 -4)
➕ src/swagger.js (+40 -0)
➕ whatsapp_api_collection.json (+216 -0)

📄 Description

This commit introduces Swagger UI for interactive API documentation and a Postman collection for easy API testing.

Adds swagger-ui-express and swagger-jsdoc to handle documentation generation and serving.
Implements JSDoc comments across all API routes in src/routes/api.js to define the API specification.
Creates a new endpoint, /api-docs, to serve the interactive Swagger UI. The UI is pre-configured to use the master API key for immediate testing.
Generates a whatsapp_api_collection.json file in the root directory. The collection includes all endpoints and a pre-request script to manage the X-MASTER-KEY header automatically.
Updates README.md with a new "API Documentation" section, explaining how to access the Swagger UI and import the Postman collection.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Codegres-com/Simple-Whatsapp-API/pull/5 **Author:** [@Codegres-com](https://github.com/Codegres-com) **Created:** 9/30/2025 **Status:** ✅ Merged **Merged:** 9/30/2025 **Merged by:** [@Codegres-com](https://github.com/Codegres-com) **Base:** `main` ← **Head:** `feature/swagger-postman-docs` --- ### 📝 Commits (1) - [`970343d`](https://github.com/Codegres-com/Simple-Whatsapp-API/commit/970343de1428d72c19188ff922496a7de1d50e23) feat: Add Swagger and Postman support ### 📊 Changes **8 files changed** (+728 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+22 -0) 📝 `package-lock.json` (+271 -0) 📝 `package.json` (+2 -0) ➕ `server.log` (+4 -0) 📝 `src/index.js` (+25 -0) 📝 `src/routes/api.js` (+148 -4) ➕ `src/swagger.js` (+40 -0) ➕ `whatsapp_api_collection.json` (+216 -0) </details> ### 📄 Description This commit introduces Swagger UI for interactive API documentation and a Postman collection for easy API testing. - Adds `swagger-ui-express` and `swagger-jsdoc` to handle documentation generation and serving. - Implements JSDoc comments across all API routes in `src/routes/api.js` to define the API specification. - Creates a new endpoint, `/api-docs`, to serve the interactive Swagger UI. The UI is pre-configured to use the master API key for immediate testing. - Generates a `whatsapp_api_collection.json` file in the root directory. The collection includes all endpoints and a pre-request script to manage the `X-MASTER-KEY` header automatically. - Updates `README.md` with a new "API Documentation" section, explaining how to access the Swagger UI and import the Postman collection. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

kerem

2026-03-03 01:17:13 +03:00

closed this issue
added the
pull-request
label

No labels

pull-request

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/Simple-Whatsapp-API#5

No description provided.

Rows
Columns