hoppscotch / docs Goto Github PK
View Code? Open in Web Editor NEW๐ Hoppscotch documentation - https://docs.hoppscotch.io
Home Page: https://docs.hoppscotch.io
License: MIT License
๐ Hoppscotch documentation - https://docs.hoppscotch.io
Home Page: https://docs.hoppscotch.io
License: MIT License
Last line on the page /docs/content/en/features/response.md
says The response from the API endpoint can be viewed here
here
and associate sample data to thathere
How can I set the environment variable in the tests script?
I was used to setting variables in postman like this:
var jsonData = JSON.parse(responseBody);
postman.setEnvironmentVariable("TOKEN", jsonData.AuthenticationResult.IdToken);
Can I do something similar in hopscotch?
Every time I log in to hoppscotch and use the REST tool, the sync history message keeps popping up. In the video I show the case.
In a few places in the docs for Hoppscotch, GitHub is referred to as Github, which is not the correct way to spell/type GitHub.
I am working on a PR to correct this issue.
The image in the route https://docs.hoppscotch.io/features/body is missing. While on closer inspection, it was confirmed that the image specified in the path is in the asset directory, which is
https://github.com/hoppscotch/docs/blob/main/static/Features/body-dark.png.
Path: /documentation/features/importer
Hi there,
can you clarify how cloud storage works?
Hoppscotch uses Cloud Storage for Firebase, right?
I searched the documentation and read 1923 and 1817. As well as Cloud Storage for Firebase and Google Cloud Storage
Cloud Storage offers secure-by-design features to protect your data and advanced controls and capabilities to keep your data private and secure against leaks or compromises. Security features include access control policies, data encryption, retention policies, retention policy locks, and signed URLs.
That sound great.
But who has access to that storage and my data?
Is it only me and my team that I created with hoppscotch.io? Or is hoppscotch as the service provider also theoretically able to decrypt and read my data?
Thanks a lot, Best Leif
I assume that this means to use preferred system but that is weird because usually you just have light and dark and it only defaults to system default. If you want to switch through it you are not interested in the system default.
Hoppscotch provides a convenient way to test your locally hosted APIs using its Browser Extension. It allows you to interact with APIs served from your local development environment directly in your browser.
Write a guide on "How to test Local APIs within Hoppscotch?", showcasing the process from installing the browser extension to testing the local APIs that you have crafted for your application. Attach the code snippets, and image frames that depict the results.
Path: /documentation/getting-started/graphql/creating-a-query
Would like to know, how we can test GrapQL responses, similar to Rest endpoints
Thanks!
the word nuxt-content is misspelled in the contributiors guide section in readme file
How can I share an enviroment with a team/other users?
Hello !
I have started the translation of the document in French so if someone also wishes to participate thank you to let me know so that I add you as a collaborator in my fort
here is the link: https://github.com/Donfreddy/docs
When browsing the docs website a 404 error is returned if the entry point is anything apart from https://docs.hoppscotch.io/.
Scenario A:
Scenario B:
In the environments tab, adding a value with a long char length (e.x. Bearer Token ~700 chars) to a variable in the variable list can be hard to scroll through using the touchpad on a mac.
Would it be possible to increase the width of the value input and or wrap the value?
Under https://github.com/hoppscotch/docs/blob/main/README.md when we click on @nuxt/content theme docs. getting below error.
I would love to fix this issue, if someone will help me with the correct url.
I am building services in cloud-run that require tokens to invoke. The recommended way to fetch a token is via a cli command. https://cloud.google.com/sdk/gcloud/reference/auth/application-default/print-access-token
gcloud auth application-default print-access-token
curl -H "X-Goog-User-Project: your-project" -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" foo.googleapis.com
How would I accomplish this in hoppscotch? It doesn't appear I can kick off a sub-process in the pre-request script.
Sometimes response comes in JSON format but with different content type (application/octet-stream for example)
In this case tab "JSON" is disabled and user cannot beautify the output
It would be useful to be able to format the response regardless of the value of the response content-type header.
When we started using Hoppscotch today, we were not able to find documentation on how to use the environment variables correctly. In the end, we found hoppscotch/hoppscotch#1029 (comment) which solved the issue for us, but we lost certainly about 1 hour until we found that comment.
Describe the solution you'd like
It would be nice to have some kind of documentation on how to use the environment variable next to the place where you can configure them (Environments, probably where you can enter the values?).
Additional context
It might not be intuitive that it is not possible to use environment variables in Parameters but in the URL.
In this line from 2.install-and-build.md
DATABASE_URL: This is where you add your Postgres database URL, you can also use our default database shipped within the docker container postgresql://postgres:testpass@hoppscotch-db:5432/hoppscotch
It mentions the existence of a default PostgreSQL database within the container. Is this correct, or was it actually meant to be within the Docker Compose?
There is some confusion regarding this matter, as discussed in hoppscotch/hoppscotch#3414 (comment)
Currently, to switch environments, the user needs to navigate from the Collections section to the Environments section, select the desired environment and return to Collections.
If the user works with 2-3 API requests and several environments that's quite a lot of extra clicks
Also in the Collection view user does not see current environment and needs to switch to the Environments section to check it
I think it would be more convenient if the environment selector was always visible - it does not take up much space and is logically part of the workspace.
Hello, I noticed this issue while browsing doc site so wanted to report here.
doc: https://docs.hoppscotch.io/documentation/clients/desktop#download-hoppscotch-desktop-app
source: https://github.com/hoppscotch/docs/blob/main/content/1.documentation/2.clients/1.desktop.md
While in mark down it mentions instruction for installation, for some reason it's not generated
Path: /documentation/develop
Can we get instructions for running the desktop version locally?
My (fortune 100) company is looking at contributing features / fixing bugs in the desktop client and it would help us to have clear instructions for running locally
How to Import api from swagger?
As called out in a few issues, it is a common pattern to take values from a response payload and use these in subsequent API calls. The most common example is fetching a JWT and using that in an Authorization header for all subsequent calls.
Things are just different enough in Hoppscotch to make examples from Postman not compatible. Unless I'm missing something obvious, I was unable to get console output from the Tests tab to tell me where things were going wrong, but I did manage to figure it out eventually.
Some small doc additions can help others not run into the same friction.
Production
Local
Path: /support/solutions/community
Dear Team,
Could you please help to check that the information "Test" and "Pre-request script" are lost after import collection from Postman to Hopposcotch even exporting from Postman using "Collection v2" or "Collection v2.1"?
Exported files from Postman:
PHUC_TEST_NE_v2.1.postman_collection.json
PHUC_TEST_NE_v2.postman_collection.json
After importing to Hopposcotch:
Thanks!
Is there a specific license that the docs are under? I see Hoppscotch itself is under MIT, should we add that here as well?
I am trying out the cli but the documentation does not have much information about the output report. Likewise, I was unsure about what the differences was between test cases, test suites, and test scripts and their counts. I want to add a PR to add some clarity.
image of banner not shown up due to minor typo in the file name
https://docs.hoppscotch.io/features/authorization
- "REST_ APIs use authorizatiom to ensure that a client has secure access only to the resources permitted by their roles. "authorizatiom
is in wrong spelling.I'm experiencing following issue related to Teams
Link for docs page
improper image file name
Rename image file name for dark mode
Path: /documentation/features/scripts
Current text: "Hoppscotch provides JavaScript APIs that can be used in writing pre-request scripts and building tests. You can enter your JavaScript code and run the necessary scripts."
Problem: there are a bazillion JavaScript languages. This needs to be clarified. For example use the standardized version called ECMA-Script.
There exists a docs page about "runner", but there is no runner in the app
The link in "Select the Grant Type from Authorization Code (with or without PKCE), Client Credentials, Password Credentials, and Implicit" redirects to /documentation/getting-started/introduction
.
It looks like the link should refer to #grant-types
, locally editing this through the inspector doesn't fix the issue.
Hoppscotch has a Guides section that consists of articles and How-to Guides. Widgets are small, interactive components that can be embedded in HTML pages to provide a dynamic environment for users.
There are three types of Hoppscotch Widgets that you can generate:
-> Links
-> Buttons
-> Embeds
Write a guide on "How to Use Hoppscotch Widgets?", showcasing the application of widgets on either your sample project, an external website, or a blog site. Include code snippets and multimedia content to demonstrate the results.
Trying to import environment from postman. I got the collection and the environment. However, the collection had many variables associated to itself. There doesn't seem to be a corresponding scripts/variables for a collection. Am I looking in the wrong place, or is this not supported?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.