JavaScripting

The definitive source of the best
JavaScript libraries, frameworks, and plugins.


  • ×

    Hoppscotch

    ๐Ÿ‘ฝ Open source API development ecosystem https://hoppscotch.io
    Filed under 

    • 🔾92%Overall
    • 35,736
    • 7 hours
    • 🕩2536
    • 👥9
    Hoppscotch Logo

    Hoppscotch

    Open source API development ecosystem

    contributions welcome Website Tests Tweet

    Built with โค๏ธŽ by contributors


    Screenshot

    Support

    Chat on Discord Chat on Telegram Discuss on GitHub

    Table of contents --- - Features - Demo - Usage - Built with - Developing - Docker - Releasing - Contributing - Continuous Integration - Changelog - Authors - License ---

    Features

    โค๏ธ Lightweight: Crafted with minimalistic UI design.

    โšก๏ธ Fast: Send requests and get/copy responses in real-time.

    HTTP Methods

    • GET - Requests retrieve resource information
    • POST - The server creates a new entry in a database
    • PUT - Updates an existing resource
    • PATCH - Very similar to PUT but makes a partial update on a resource
    • DELETE - Deletes resource or related component
    • HEAD - 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 resource
    • OPTIONS - Describe the communication options for the target resource
    • TRACE - Performs a message loop-back test along the path to the target resource
    • <custom> - Some APIs use custom request methods such as LIST. Type in your custom methods.

    ๐ŸŒˆ Make it yours: Customizable combinations for background, foreground, and accent colors โ€” customize now.

    Theming

    • Choose a theme: System (default), Light, Dark, and Black
    • Choose accent color: Green (default), Teal, Blue, Indigo, Purple, Yellow, Orange, Red, and Pink
    • Distraction-free Zen mode

    Customized themes are synced with cloud / local session

    ๐Ÿ”ฅ PWA: Install as a PWA 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.

    1. Choose method
    2. Enter URL
    3. Send

    4. Copy/share public "Share URL"

    5. Generate/copy request code snippets for 10+ languages and frameworks
    6. Import cURL
    7. 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 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 as.

    ๐Ÿ“ซ 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 response to clipboard
    • Download response as a file
    • View response headers
    • View raw and preview of HTML, image, JSON, XML responses

    โฐ History: Request entries are synced with cloud / local session storage to restore with a single click.

    ๐Ÿ“ 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 cloud / local session storage

    ๐ŸŒ 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

    ๐Ÿ“œ 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

    ๐Ÿ“„ API Documentation: Create and share dynamic API documentation easily, quickly.

    1. Add your requests to Collections and Folders
    2. Export Collections and easily share your APIs with the rest of your team
    3. Import Collections and Generate Documentation on-the-go

    โŒจ๏ธ Keyboard Shortcuts: Optimized for efficiency.

    Read our documentation on Keyboard Shortcuts

    ๐ŸŒŽ i18n: Experience the app in your language.

    Help us to translate Hoppscotch. Please read TRANSLATIONS for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

    ๐Ÿ“ฆ Add-ons: Official add-ons for hoppscotch.

    Add-ons are developed and maintained under Hoppscotch Organization.

    โ˜๏ธ Auth + Sync: Sign in and sync your data in real-time.

    Sign in with

    • GitHub
    • Google
    • Email

    Synchronize your data

    • 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
    • Any JavaScript functions

    ๐ŸŒฑ 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 ---

    ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Teams ฮฒ: Helps you collaborate across your team to design, develop, and test APIs faster.

    • Unlimited teams
    • Unlimited shared collections
    • Unlimited team members
    • Role-based access control
    • Cloud sync
    • Multiple devices

    ๐Ÿšš 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

    For more features, please read our documentation.

    Demo

    hoppscotch.io

    Usage

    1. Provide your API endpoint in the URL field
    2. CLick "Send" to simulate the request
    3. View the response

    Built with

    Developing

    1. Update .env.example file found in packages/hoppscotch-app with your own keys and rename it to .env.

    Sample keys only work with the production build.

    Browser-based development environment

    Local development environment

    1. Clone this repo with git.
    2. Install pnpm using npm by running npm install -g pnpm.
    3. Install dependencies by running pnpm install within the directory that you cloned (probably hoppscotch).
    4. Start the development server with pnpm run dev.
    5. Open the development site by going to http://localhost:3000 in your browser.

    Docker compose

    1. Clone this repo with git.
    2. Run docker-compose up within the directory that you cloned (probably hoppscotch).
    3. Open the development site by going to http://localhost:3000 in your browser.

    Docker

    Official container   hoppscotch/hoppscotch

    docker run --rm --name hoppscotch -p 3000:3000 hoppscotch/hoppscotch:latest
    

    Releasing

    1. Clone this repo with git.
    2. Install pnpm using npm by running npm install -g pnpm.
    3. Install dependencies by running pnpm install within the directory that you cloned (probably hoppscotch).
    4. Build the release files with pnpm run generate.
    5. Find the built project in packages/hoppscotch-app/dist.

    Contributing

    Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

    Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

    Continuous Integration

    We use GitHub Actions for continuous integration. Check out our build workflows.

    Changelog

    See the CHANGELOG file for details.

    Authors

    This project exists thanks to all the people who contribute โ€” contribute.

    License

    This project is licensed under the MIT License - see the LICENSE file for details.

    Show All