
Hoppscotch
Open Source API Development Ecosystem
Backend
hoppscotch/hoppscotch-backend
Just deployed
Admin
hoppscotch/hoppscotch-admin
Just deployed
Postgres
postgres:15
Just deployed
/var/lib/postgresql/data
Frontend
hoppscotch/hoppscotch-frontend
Just deployed
Hoppscotch
Open Source API Development Ecosystem
Hoppscotch is a lightweight, web-based API development suite.
It was built from the ground up with ease of use and accessibility in mind providing all the functionality needed for API developers with minimalist, unobtrusive UI.
Notes:
-
This template comes with Email based authentication by default, the first user to log in will be created as an admin. If you wish to change login methods please do that via the admin interface.
-
Communication to Postgres is done exclusively over the private network and the database is not exposed externally in any way by default, if you want to enable access from outside of the private network you can go to the databases settings to enable TCP proxying and enter the internal port (5432) the TCP proxy can be again removed at any point to close off external access.
I highly recommend you take a look at the Hoppscotch Documentation to learn more about the app.
Features
โค๏ธ Lightweight: Crafted with minimalistic UI design.
โก๏ธ Fast: Send requests and get responses in real time.
๐๏ธ HTTP Methods: Request methods define the type of action you are requesting to be performed.
GET
๏ผ Requests retrieve resource informationPOST
๏ผ The server creates a new entry in a databasePUT
๏ผ Updates an existing resourcePATCH
๏ผ Very similar toPUT
but makes a partial update on a resourceDELETE
๏ผ Deletes resource or related componentHEAD
๏ผ Retrieve response headers identical to those of a GET request, but without the response body.CONNECT
๏ผ Establishes a tunnel to the server identified by the target resourceOPTIONS
๏ผ Describe the communication options for the target resourceTRACE
๏ผ Performs a message loop-back test along the path to the target resourcecustom
๏ผ Some APIs use custom request methods such asLIST
. Type in your custom methods.
๐ Theming: Customizable combinations for background, foreground, and accent colors โ customize now.
- Choose a theme: System preference, Light, Dark, and Black
- Choose accent colors: Green, Teal, Blue, Indigo, Purple, Yellow, Orange, Red, and Pink
- Distraction-free Zen mode
Customized themes are synced with your cloud/local session.
๐ฅ PWA: Install as a Progressive Web App on your device.
- Instant loading with Service Workers
- Offline support
- Low RAM/memory and CPU usage
- Add to Home Screen
- Desktop PWA
๐ Request: Retrieve response from endpoint instantly.
- Choose
method
- Enter
URL
- Send
- Copy/share public "Share URL"
- Generate/copy request code snippets for 10+ languages and frameworks
- Import
cURL
- Label requests
๐ WebSocket: Establish full-duplex communication channels over a single TCP connection.
๐ก Server-Sent Events: Receive a stream of updates from a server over an HTTP connection without resorting to polling.
๐ฉ Socket.IO: Send and Receive data with the SocketIO server.
๐ฆ MQTT: Subscribe and Publish to topics of an MQTT Broker.
๐ฎ GraphQL: GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data.
- Set endpoint and get schema
- Multi-column docs
- Set custom request headers
- Query schema
- Get query response
๐ Authorization: Allows to identify the end-user.
- None
- Basic
- Bearer Token
- OAuth 2.0
- OIDC Access Token/PKCE
๐ข Headers: Describes the format the body of your request is being sent in.
๐ซ Parameters: Use request parameters to set varying parts in simulated requests.
๐ Request Body: Used to send and receive data via the REST API.
- Set
Content Type
- FormData, JSON, and many more
- Toggle between key-value and RAW input parameter list
๐ฎ Response: Contains the status line, headers, and the message/response body.
- Copy the response to the clipboard
- Download the response as a file
- View response headers
- View raw and preview HTML, image, JSON, and XML responses
โฐ History: Request entries are synced with your cloud/local session storage.
๐ Collections: Keep your API requests organized with collections and folders. Reuse them with a single click.
- Unlimited collections, folders, and requests
- Nested folders
- Export and import as a file or GitHub gist
Collections are synced with your cloud/local session storage.
๐ Pre-Request Scripts: Snippets of code associated with a request that is executed before the request is sent.
- Set environment variables
- Include timestamp in the request headers
- Send a random alphanumeric string in the URL parameters
- Any JavaScript functions
๐จโ๐ฉโ๐งโ๐ฆ Teams: Helps you collaborate across your teams to design, develop, and test APIs faster.
- Create unlimited teams
- Create unlimited shared collections
- Create unlimited team members
- Role-based access control
- Cloud sync
- Multiple devices
๐ฅ Workspaces: Organize your personal and team collections environments into workspaces. Easily switch between workspaces to manage multiple projects.
- Create unlimited workspaces
- Switch between personal and team workspaces
โจ๏ธ Keyboard Shortcuts: Optimized for efficiency.
> Read our documentation on Keyboard Shortcuts
๐ Proxy: Enable Proxy Mode from Settings to access blocked APIs.
- Hide your IP address
- Fixes
CORS
(Cross-Origin Resource Sharing) issues - Access APIs served in non-HTTPS (
http://
) endpoints - Use your Proxy URL
Official proxy server is hosted by Hoppscotch - GitHub - Privacy Policy.
๐ i18n: Experience the app in your language.
โ๏ธ Auth + Sync: Sign in and sync your data in real-time across all your devices.
Sign in with:
- GitHub
- Microsoft
- Email (Default)
๐ Synchronize your data: Handoff to continue tasks on your other devices.
- Workspaces
- History
- Collections
- Environments
- Settings
โ Post-Request Tests: Write tests associated with a request that is executed after the request's response.
- Check the status code as an integer
- Filter response headers
- Parse the response data
- Set environment variables
- Write JavaScript code
๐ฑ Environments: Environment variables allow you to store and reuse values in your requests and scripts.
- Unlimited environments and variables
- Initialize through the pre-request script
- Export as / import from GitHub gist
Use-cases
- By storing a value in a variable, you can reference it throughout your request section
- If you need to update the value, you only have to change it in one place
- Using variables increases your ability to work efficiently and minimizes the likelihood of error
๐ Bulk Edit: Edit key-value pairs in bulk.
- Entries are separated by newline
- Keys and values are separated by
:
- Prepend
#
to any row you want to add but keep disabled
๐๏ธ Admin dashboard: Manage your team and invite members.
- Insights
- Manage users
- Manage teams
Template Content
SMTP_HOST
The SMTP hostname to be used for Email authentication
SMTP_PASSWORD
The Email accounts' password to be used for Email authentication
SMTP_USERNAME
The Email accounts' username to be used for Email authentication
Postgres
postgres:15Frontend
hoppscotch/hoppscotch-frontend