[GH-ISSUE #2018] [feature]: Write API documentation and Generate OpenAPI Specification #655

Open
opened 2026-03-16 16:32:19 +03:00 by kerem · 3 comments
Owner

Originally created by @Link2Twenty on GitHub (Dec 16, 2021).
Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/2018

Is there an existing issue for this?

  • I have searched the existing issues

Summary

I see there is a way to make markdown documentation for an API, it would really awesome if we could also generate OpenAPI documentation.

Why should this be worked on?

I think it's fair to say OpenAPI docs are used across the whole industry but are a bit of a pain to manage. Making hopscotch the best place to create and maintain OpenAPI docs would surely encourage greater adoption.

Originally created by @Link2Twenty on GitHub (Dec 16, 2021). Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/2018 ### Is there an existing issue for this? - [X] I have searched the existing issues ### Summary I see there is a way to make markdown documentation for an API, it would really awesome if we could also generate OpenAPI documentation. ### Why should this be worked on? I think it's fair to say OpenAPI docs are used across the whole industry but are a bit of a pain to manage. Making hopscotch the best place to create and maintain OpenAPI docs would surely encourage greater adoption.
Author
Owner

@juzhiyuan commented on GitHub (Jan 8, 2022):

Hi @Link2Twenty, would you like to draft a detailed proposal?

<!-- gh-comment-id:1007904280 --> @juzhiyuan commented on GitHub (Jan 8, 2022): Hi @Link2Twenty, would you like to draft a detailed proposal?
Author
Owner

@manuel-salvatori-lrn commented on GitHub (Nov 14, 2024):

Is there any update on this important feature implementation?

<!-- gh-comment-id:2476948309 --> @manuel-salvatori-lrn commented on GitHub (Nov 14, 2024): Is there any update on this important feature implementation?
Author
Owner

@mazlum commented on GitHub (May 5, 2025):

+1

<!-- gh-comment-id:2850001705 --> @mazlum commented on GitHub (May 5, 2025): +1
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#655
No description provided.