kushkapadia / kushkapadia/servitect

Add an option to automatically generate API documentation using Swagger or Postman collections

Open
#37 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
JavaScript
Stars
46
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Currently, Servitect focuses on generating a backend server with clean and modular code but lacks built-in API documentation support. To enhance developer experience and make the APIs easier to understand and consume, it would be beneficial to include a feature for automatic API documentation generation.

The proposed feature should include:

Swagger Integration:

Automatically generate a swagger.json file for all routes and controllers.
Provide a web-based UI to explore and test the APIs.
Postman Collection:

Generate a Postman collection file that developers can directly import to test APIs.
Customization Options:

Allow developers to add descriptions, request/response examples, and other metadata for endpoints.
Versioning Support:

Ensure the documentation supports API versioning to align with production standards.
This feature will significantly improve Servitect’s usability by offering a streamlined way to document and test APIs, reducing the time spent on manual documentation.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing Servitect’s menu-driven Node.js MVC generator and how it emits routes and controllers; the payload names no specific files or tests. Clarify whether Swagger/OpenAPI, Postman, or both are required, then define how endpoint metadata and API versioning are supplied. Done means the generator produces the agreed documentation artifacts and a usable API exploration workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, openapi, postman
Domain
api, backend, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.