mirror of
https://github.com/hoppscotch/hoppscotch.git
synced 2026-04-26 01:06:00 +03:00
[GH-ISSUE #1875] [feature]: Ability to save API response #599
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#599
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 @bhav15h on GitHub (Oct 14, 2021).
Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/1875
Is your feature request related to a problem? Please describe.
I would like to be able to save an API response similar to the feature in postman.
Describe the solution you'd like
The solution for this is when a request to an API has returned a result we have a new button to save the response. This would be nested under the saved API request.
We should be able to rename the saved response as there could be different responses from 1 request. e.g if an exception was raised in the api we could receive a different response.
Describe alternatives you've considered
At the moment the only alternative is to save the response in a file locally, but this is very hectic and not easily sharable to other people in the team as we may have a long list of 100 APIs.
Additional context
Postman seem to have done it very well.
@liyasthomas commented on GitHub (Oct 14, 2021):
Hi @bhav15h, saving response along with the request seems like an handy feature. We'll consider implementing this on a later stage. If anyone wants to contribute to this feature request, feel free to pick it up.
@sguzmanm commented on GitHub (Oct 17, 2021):
Hi, this seems interesting, mind if I look into it?
@liyasthomas commented on GitHub (Oct 18, 2021):
@sguzmanm yes, feel free to pick this up.
@sguzmanm commented on GitHub (Oct 24, 2021):
Hi @liyasthomas I've been having a hard time trying to work on the issue since I see it's too big, would you mind looking at the linked PR for further guidance?
@Selvestr1 commented on GitHub (Nov 15, 2021):
@chirag-jn commented on GitHub (Feb 12, 2022):
Hey @liyasthomas, are there plans to add this feature anytime soon?
@m-roberts commented on GitHub (May 19, 2022):
+1 for this feature. Postman has the ability to save an API response as an "example" under requests in a collection.
@AndrewBastin commented on GitHub (May 19, 2022):
This is something we have debated a lot on whether or not to implement, even had the PR in. But what we think is "Examples" as a thing within requests are more of a documentation thing and not exactly a "Testing" thing.
We are really vary and careful with the things we want to the REST Testing pages because we do not want to build Hoppscotch into an open-source Postman. This doesn't mean we will not tackle this issue (this issue is still open and will remain open until a solution is pushed), but we are planning on a solution we think is more better suited for the documentation way of doing things, this will take some time though as we are focused on other things to tackle before going for this.
@Elghazal commented on GitHub (Sep 7, 2022):
+1 for this feature
@mojerro commented on GitHub (Sep 25, 2022):
I think this feature is connected with #1598. If we have the mock ability, then this feature is very convenient and can be a part of the mock feature
Also, I think it can be very convenient if we can generate API doc automated. But for now, I need to save my API doc in another place and rewrite the response again.
@Msiavashi commented on GitHub (Feb 22, 2023):
I'd like to look into implementing this feature.
@AndrewBastin Have you been able to find a solution yet? I agree that examples are more of a documentation, though having both integrated seamlessly works nicely sometimes. The way Postman handles it is quick and easy to access and reproduce.
Please let me know if there has been any progress in this regard.
Thanks
@DarkPhoenix2704 commented on GitHub (Jul 16, 2023):
+1 For this Feature
@rohit-serri commented on GitHub (Jul 20, 2023):
Recently Switched to HoppScotch from postman, this feature would be a important addition. Any Updates on this? can i help in any way by contributing to the repo? i might need some guidance if anyone is able to help
@Hamma111 commented on GitHub (Jul 31, 2023):
I came across HoppScotch to find it as a lovely open source project, and it really is. But the only thing holding me back from migrating my projects to HoppScotch is ability save responses/mock/examples.
It is very convenient to save API response, right with the actual API, with certain payloads etc to give idea to team about different scenarios.
+1 to this feature please
@JayJayDee commented on GitHub (Aug 3, 2023):
+1 For this Feature
@lixh00 commented on GitHub (Aug 23, 2023):
+1 For this Feature
@SamJakob commented on GitHub (Sep 3, 2023):
See also #2018 with respect to being able to save responses as 'examples'.
@tranghaviet commented on GitHub (Sep 15, 2023):
+1 For this Feature
@tomasztomys commented on GitHub (Sep 26, 2023):
+1
@RussianProtein commented on GitHub (Oct 9, 2023):
+1
@CMFerrer commented on GitHub (Oct 21, 2023):
+1 for this feature
@umaraziz0 commented on GitHub (Oct 30, 2023):
+1 for this feature
@sarankumar-ns commented on GitHub (Nov 15, 2023):
+1
@lakuapik commented on GitHub (Nov 15, 2023):
+1
@ricardomedina98 commented on GitHub (Nov 16, 2023):
+1
@yaseeen96 commented on GitHub (Nov 18, 2023):
+1
@LeulAria commented on GitHub (Nov 21, 2023):
can we have this feature plz 💯
@AlirezaAbsolution commented on GitHub (Jan 4, 2024):
+1
@kumarahul98 commented on GitHub (Jan 14, 2024):
+1
@stavan-vc commented on GitHub (Feb 15, 2024):
+1!
Please add soon.
@Kimilhee commented on GitHub (Feb 16, 2024):
+1 For this Feature.
Please.
@cheol-95 commented on GitHub (Feb 16, 2024):
+1 For this Feature.
@AayushTaneja commented on GitHub (Mar 15, 2024):
+1
@nupis-DanielS commented on GitHub (Mar 18, 2024):
+1
@GuidoHeintz commented on GitHub (Mar 19, 2024):
+1
@khanakia commented on GitHub (Apr 2, 2024):
+1
@lifang218c commented on GitHub (May 21, 2024):
+1 need to. mock response examples! thanks
@BlackMocca commented on GitHub (May 21, 2024):
+1
@niloy-netcom commented on GitHub (May 22, 2024):
+1
@joshmartinlumi commented on GitHub (Jun 12, 2024):
+1
@ebbdebrincat commented on GitHub (Jun 12, 2024):
+1
@Gautam-Diwan commented on GitHub (Jun 20, 2024):
Considering Hoppscotch has an unlimited workspaces and teams limit, this feature seems like a no brainer to add. Will be glad to contribute for this feature with some help if considered.
@Espleth commented on GitHub (Jul 23, 2024):
+1
@hussamgamal commented on GitHub (Aug 13, 2024):
+1
@marcelo-mozena commented on GitHub (Sep 10, 2024):
+1
@saurabh-singh2 commented on GitHub (Sep 13, 2024):
+1 for this feature
@miarond commented on GitHub (Sep 25, 2024):
+1 - Would really like this feature as well.
@nivedin commented on GitHub (Oct 7, 2024):
this feature has been implemented with latest release
@abatishchev commented on GitHub (Dec 14, 2024):
I'm using v2024.11.0 and when click on a request in history, it doesn't contain the original response, it's empty instead.
When the feature will be released?
@liyasthomas commented on GitHub (Dec 14, 2024):
Hi @abatishchev, just a heads up - this feature is available from version 2024.9.0.
By the way, I wanted to clarify that the API response won’t be saved in the History entries. Instead, it’s part of the requests that you save to Collections. Make sure you’ve saved the response as an example to a collection so you can use it again and again. Please refer to documentation to learn how to Save a response as an Example.
@abatishchev commented on GitHub (Dec 14, 2024):
I see. Is there a feature request to save responses into the history? I'd like to +1 it.
For the context, I'm migrating from Postman and I'm making this feature.
It's a potential security loophole and the reason to stop using Postman, but with proper safeguards (such as automatic timely cleanup) it can be made usable and secure, imo.
@ahanprojects commented on GitHub (Mar 19, 2025):
Is there any updates on this? I think this will be an excellent feature. But I have a different question, why is my "save the request to create example" button greyed out?
@liyasthomas commented on GitHub (Mar 19, 2025):
@ahanprojects, before saving the request, ensure that the current request tab is saved to a collection. This will save the request’s responses as examples.