mirror of
https://github.com/hoppscotch/hoppscotch.git
synced 2026-04-26 01:06:00 +03:00
[GH-ISSUE #326] Generate API documentation #120
Labels
No labels
CodeDay
a11y
browser limited
bug
bug fix
cli
core
critical
design
desktop
discussion
docker
documentation
duplicate
enterprise
feature
feature
fosshack
future
good first issue
hacktoberfest
help wanted
i18n
invalid
major
minor
need information
need testing
not applicable to hoppscotch
not reproducible
pull-request
question
refactor
resolved
sandbox
self-host
spam
stale
testmu
wip
wont fix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
starred/hoppscotch#120
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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
@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.
@liyasthomas commented on GitHub (Nov 23, 2019):
Our Export collection feature could be used to make such a similar feature.
@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.
@liyasthomas commented on GitHub (Nov 25, 2019):
Great!