[GH-ISSUE #326] Generate API documentation #120

Closed
opened 2026-03-16 13:31:15 +03:00 by kerem · 4 comments
Owner

Originally created by @threeaccents on GitHub (Nov 22, 2019).
Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/326

Is your feature request related to a problem? Please describe.
The only reason I always stick around with Postman is that they generate api docs based on the request in a collection. I had used Insomnia for a while but always went back to Postman for that reason. Even though the docs they generate aren't the best looking or very UX friendly as a developer it is the easiest solution to generate docs.

Describe the solution you'd like
Have a way to generate beautiful docs based on a collection.

Describe alternatives you've considered
Going back to postman

Additional context
Example docs generated: https://documenter.getpostman.com/view/8709579/SVzw511N?version=latest

Originally created by @threeaccents on GitHub (Nov 22, 2019). Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/326 **Is your feature request related to a problem? Please describe.** The only reason I always stick around with Postman is that they generate api docs based on the request in a collection. I had used Insomnia for a while but always went back to Postman for that reason. Even though the docs they generate aren't the best looking or very UX friendly as a developer it is the easiest solution to generate docs. **Describe the solution you'd like** Have a way to generate beautiful docs based on a collection. **Describe alternatives you've considered** Going back to postman **Additional context** Example docs generated: https://documenter.getpostman.com/view/8709579/SVzw511N?version=latest
Author
Owner

@liyasthomas commented on GitHub (Nov 22, 2019):

Will work on it. We're just started and make sure to include this awesome feature in our pipeline.

<!-- gh-comment-id:557730736 --> @liyasthomas commented on GitHub (Nov 22, 2019): Will work on it. We're just started and make sure to include this awesome feature in our pipeline.
Author
Owner

@liyasthomas commented on GitHub (Nov 23, 2019):

Our Export collection feature could be used to make such a similar feature.

<!-- gh-comment-id:557762263 --> @liyasthomas commented on GitHub (Nov 23, 2019): Our Export collection feature could be used to make such a similar feature.
Author
Owner

@threeaccents commented on GitHub (Nov 25, 2019):

Awesome I haven't read the code base fully yet but once I get aquatinted to it maybe I can help out some with PRs for this feature.

<!-- gh-comment-id:558390813 --> @threeaccents commented on GitHub (Nov 25, 2019): Awesome I haven't read the code base fully yet but once I get aquatinted to it maybe I can help out some with PRs for this feature.
Author
Owner

@liyasthomas commented on GitHub (Nov 25, 2019):

Great!

<!-- gh-comment-id:558391482 --> @liyasthomas commented on GitHub (Nov 25, 2019): Great!
Sign in to join this conversation.
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/hoppscotch#120
No description provided.