starred/hoppscotch

Fork 0

mirror of https://github.com/hoppscotch/hoppscotch.git synced 2026-04-25 16:55:59 +03:00

[GH-ISSUE #4133] [feature]: Add API Documentation Generation Feature #1480

New issue

Closed

opened 2026-03-16 20:28:59 +03:00 by kerem · 6 comments

kerem commented

2026-03-16 20:28:59 +03:00

Owner

Originally created by @erfuuan on GitHub (Jun 19, 2024).
Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/4133

Originally assigned to: @nivedin on GitHub.

Is there an existing issue for this?

I have searched the existing issues

Summary

Feature Request: API Documentation Generation

Overview:
I would like to request the addition of an API documentation generation feature in Hoppscotch. This feature will enable users to generate comprehensive API documentation directly from their collections.

Detailed Description:

Purpose: To enhance usability by allowing users to generate and share API documentation easily.
Functionality:
    Users can add descriptions to their requests.
    Users can organize requests into collections.
    A new "Generate Documentation" option for collections.
    Generated documentation includes endpoint details, parameters, headers, request/response examples, and descriptions.
    Users can publish the documentation and get a sharable URL.
    Support for Markdown formatting in descriptions.

Benefits:

Provides an easy way for users to document their APIs.
Improves team collaboration by making API endpoints understandable.
Enhances user experience by integrating documentation capabilities within the app.

Thank you for considering this request!

Why should this be worked on?

Current Problem:
Hoppscotch does not have an integrated way to generate and share API documentation. Users must rely on external tools, which can be time-consuming and inconsistent.

Use Cases:

API Development Teams: Need clear and accessible documentation for all team members to understand API endpoints, parameters, and responses.
Clients and Partners: Require detailed and accurate documentation for effective API integration.
Individual Developers: Benefit from a unified platform to manage API requests and documentation together.

Benefits:

Efficiency: Saves time by generating documentation directly from Hoppscotch.
Consistency: Ensures documentation is always up-to-date.
Collaboration: Enhances team collaboration with a single source of truth for API documentation.
User Experience: Improves user experience by integrating documentation capabilities into Hoppscotch.

Originally created by @erfuuan on GitHub (Jun 19, 2024). Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/4133 Originally assigned to: @nivedin on GitHub. ### Is there an existing issue for this? - [X] I have searched the existing issues ### Summary Feature Request: API Documentation Generation Overview: I would like to request the addition of an API documentation generation feature in Hoppscotch. This feature will enable users to generate comprehensive API documentation directly from their collections. Detailed Description: Purpose: To enhance usability by allowing users to generate and share API documentation easily. Functionality: Users can add descriptions to their requests. Users can organize requests into collections. A new "Generate Documentation" option for collections. Generated documentation includes endpoint details, parameters, headers, request/response examples, and descriptions. Users can publish the documentation and get a sharable URL. Support for Markdown formatting in descriptions. Benefits: Provides an easy way for users to document their APIs. Improves team collaboration by making API endpoints understandable. Enhances user experience by integrating documentation capabilities within the app. Thank you for considering this request! ### Why should this be worked on? Current Problem: Hoppscotch does not have an integrated way to generate and share API documentation. Users must rely on external tools, which can be time-consuming and inconsistent. Use Cases: API Development Teams: Need clear and accessible documentation for all team members to understand API endpoints, parameters, and responses. Clients and Partners: Require detailed and accurate documentation for effective API integration. Individual Developers: Benefit from a unified platform to manage API requests and documentation together. Benefits: Efficiency: Saves time by generating documentation directly from Hoppscotch. Consistency: Ensures documentation is always up-to-date. Collaboration: Enhances team collaboration with a single source of truth for API documentation. User Experience: Improves user experience by integrating documentation capabilities into Hoppscotch.

kerem

2026-03-16 20:28:59 +03:00

closed this issue
added the
feature
label

kerem commented

2026-03-16 20:29:15 +03:00

Author

Owner

@BlackMocca commented on GitHub (Jun 25, 2024):

I Implement external tool for auto generate and update document from Hoppscotch with selfhost
if you interested see more detail on

https://hub.docker.com/r/blackmocca/hopp-api-doc
https://github.com/BlackMocca/hopp-api-doc

@BlackMocca commented on GitHub (Jun 25, 2024): I Implement external tool for auto generate and update document from Hoppscotch with selfhost if you interested see more detail on https://hub.docker.com/r/blackmocca/hopp-api-doc https://github.com/BlackMocca/hopp-api-doc

kerem commented

2026-03-16 20:29:20 +03:00

Author

Owner

@zviklmatej7-hub commented on GitHub (Sep 19, 2025):

https://github.com/hoppscotch/hoppscotch/issues/4133

@zviklmatej7-hub commented on GitHub (Sep 19, 2025): https://github.com/hoppscotch/hoppscotch/issues/4133

kerem commented

2026-03-16 20:29:25 +03:00

Author

Owner

@zviklmatej7-hub commented on GitHub (Sep 19, 2025):

Efficiency: Saves time by generating documentation directly from Hoppscotch.
Consistency: Ensures documentation is always up-to-date.
Collaboration: Enhances team collaboration with a single source of truth for API documentation.
User Experience: Improves user experience by integrating documentation capabilities into Hoppscotch.

@zviklmatej7-hub commented on GitHub (Sep 19, 2025): Efficiency: Saves time by generating documentation directly from Hoppscotch. Consistency: Ensures documentation is always up-to-date. Collaboration: Enhances team collaboration with a single source of truth for API documentation. User Experience: Improves user experience by integrating documentation capabilities into Hoppscotch.

kerem commented

2026-03-16 20:29:30 +03:00

Author

Owner

@zviklmatej7-hub commented on GitHub (Sep 19, 2025):

Response-Interface.txt

@zviklmatej7-hub commented on GitHub (Sep 19, 2025): [Response-Interface.txt](https://github.com/user-attachments/files/22435209/Response-Interface.txt)

kerem commented

2026-03-16 20:29:35 +03:00

Author

Owner

@jamesgeorge007 commented on GitHub (Nov 5, 2025):

Implementation of the API documentation feature is underway. Please track the progress in #5499.

@jamesgeorge007 commented on GitHub (Nov 5, 2025): Implementation of the API documentation feature is underway. Please track the progress in #5499.

kerem commented

2026-03-16 20:29:40 +03:00

Author

Owner

@jamesgeorge007 commented on GitHub (Nov 27, 2025):

Closing since the API documentation feature is now out with the v2025.11.0 release. Please refer to the documentation for more context.

Note: API Documentation is an experimental feature currently in public beta. We welcome your feedback as we continue to refine and improve this capability.

@jamesgeorge007 commented on GitHub (Nov 27, 2025): Closing since the API documentation feature is now out with the [v2025.11.0 release](https://github.com/hoppscotch/hoppscotch/releases/tag/2025.11.0). Please refer to the [documentation](https://docs.hoppscotch.io/documentation/features/documentation#api-documentation) for more context. **Note**: API Documentation is an experimental feature currently in public beta. We welcome your feedback as we continue to refine and improve this capability.

kerem referenced this issue

2026-03-17 00:57:58 +03:00

[PR #1480] [MERGED] [Feat:Teams] Team collections tab and View team collections #3341