Skip to content
main
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Oct 15, 2020
Jun 19, 2020
v2
Aug 13, 2020
v2
Aug 13, 2020
v2
Aug 13, 2020
v2
Aug 13, 2020
Aug 13, 2020
Aug 17, 2020

README.md

hoppscotch.io logo

Hoppscotch - A free, fast and beautiful API request builder

Helps you create requests faster, saving precious time on development - Subscribe

Website Travis Build Status GitHub release Tweet

Built with โค๏ธŽ by liyasthomas and contributors

Screenshot1

Contact

Chat on Telegram Chat on Discord

Support

Sponsor on GitHub Contribute on Open Collective Join on Patreon Donate on PayPal

Table of contents

Features

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

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

Methods

  • GET - Requests retrieve resource information
  • HEAD - Retrieve response headers identical to those of a GET request, but without the response body.
  • POST - The server creates a new entry in a database
  • PUT - Updates an existing resource
  • DELETE - Deletes resource or related component
  • 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
  • PATCH - Very similar to PUT but makes a partial update on a 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.

Theming: Customize now โœจ

  • Choose theme: System, Light, Dark (default) and Black
  • Choose accent color: Blue, Green (default), Teal, Purple, Orange, Pink, Red, and Yellow
  • Toggle multi-colored headings
  • Toggle auto-scroll to response

Customized themes are synced with local session storage

๐Ÿ”ฅ PWA: Install as a PWA on your device.

Features

  • 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

Features

  • 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.

  • Send and receive data
  • Basic and Bearer Token authentication

๐Ÿ“ก Server Sent Events: Receive a stream of updates from a server over a HTTP connection without resorting to polling.

๐ŸŒฉ Socket.IO: Send and Receive data with SocketIO server.

๐ŸฆŸ MQTT: Subscribe and Publish to topics of a 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 schemas
  • Multi-column docs
  • Set custom request headers
  • Query schema
  • Get query response

๐Ÿ” Authentication: Allows to identify the end user.

Types

  • 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.

Options

  • Set Content Type
  • Add or remove Parameter list
  • Toggle between key-value and RAW input parameter list

๐Ÿ‘‹ Responses: Contains the status line, headers and the message/response body.

  • Copy response to clipboard
  • Download response as a file
  • View preview of HTML 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.

Collections are synced with cloud / local session storage

๐ŸŒ Proxy: Enable Proxy Mode from Settings to access blocked APIs.

Features

  • Hide your IP address
  • Fixes CORS (Cross Origin Resource Sharing) issues
  • Access APIs served in non-HTTPS (http://)
  • Use custom Proxy URL

Official Hoppscotch Proxy is hosted by Apollo Software - Privacy Policy

๐Ÿ“œ Pre-Request Scripts ฮฒ: Snippets of code associated with a request that are executed before the request is sent.

Use-cases

  • Include timestamp in the request headers
  • Send a random alphanumeric string in the URL parameters

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

Usage

  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.

Shortcuts WIki

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

  1. Scroll down to the footer
  2. Click "Choose Language" icon button
  3. Select your language from the menu

Keep in mind: Translations aren't available for all source and target language combinations

To provide a localized experience for users around the world, you can add you own translations.

All i18n contributions are welcome to i18n branch only!

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

Add-ons are developed and maintained under Official Hoppscotch Organization.

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

Sign in with

  • Google
  • GitHub

Sync

  • History
  • Collections
  • Environments
  • Notes

โœ… Post-Request Tests ฮฒ: Write tests associated with a request that are executed after the request response.

Use-cases

  • Check the status code as an integer
  • Filter response headers
  • Parse the response data

๐Ÿ“ Notes : Instantly jot down notes, tasks or whatever you feel like as they come to your mind.

Notes are only available for signed-in users

๐ŸŒฑ Environments : Environment variables allow you to store and reuse values in your requests and scripts.

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

To find out more, please check out Hoppscotch Wiki.

Demo

hoppscotch.io

Usage

  1. Choose method
  2. Enter URL
  3. Send request
  4. Get response

Built with

Developing

  1. Update .env.example file found in repository's root directory with your own keys and rename it to .env.

Sample keys only works with the production build.

Browser based development environment

Open in Gitpod

Local development environment

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

Docker compose

  1. Clone this repo with git.
  2. Run docker-compose up
  3. Open development site by going to http://localhost:3000 in your browser.

Docker

#pull
docker pull liyasthomas/postwoman

#build
docker build -t postwoman:latest .

#run
docker run -p 3000:3000 postwoman:latest

Releasing

  1. Clone this repo with git.
  2. Install dependencies by running npm install within the directory that you cloned (probably hoppscotch).
  3. Build the release files with npm run generate.
  4. Find the built project in ./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 Travis CI for continuous integration. Check out our Travis CI Status.

Versioning

This project is developed by Liyas Thomas using the Semantic Versioning specification. For the versions available, see the releases on this repository.

Changelog

See the CHANGELOG file for details.

Authors

Lead Developers

Testing and Debugging

Collaborators


Liyas Thomas

๐Ÿ’ป ๐ŸŽจ

Andrew Bastin

๐Ÿ’ป

John Harker

๐Ÿ’ป

James George

๐Ÿ’ป

See the list of contributors who participated in this project.

Thanks

Financial Contributors

Become a financial contributor and help us sustain our community [Support].

GitHub Sponsors

Gianluca Pisati Kenny Cheung Shivam Mishra Zach Silveira Harshit Pant Jan Piotrowski Anil Kumar Gabriel Peal Kristjรกn Oddsson Don Okuda Erica Brescia Tom Preston-Werner Max Lynch Brian Shaler Max Stoiber John Caine

Open Collective

๐Ÿงš Angel Sponsors

Paw

Code Contributors

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.

Acknowledgements

  • Hat tip to anyone whose code was used
  • Inspirations:

Badges

Preview Markdown code


Default
[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-202124?logo=postwoman)](https://hoppscotch.io)


Success
[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-success?logo=postwoman)](https://hoppscotch.io)


Critical
[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-critical?logo=postwoman)](https://hoppscotch.io)


Custom
[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-blueviolet?logo=postwoman)](https://hoppscotch.io)


Customize
[![hoppscotch](https://img.shields.io/badge/your_text-Hoppscotch-hex_color_code?logo=postwoman)](https://hoppscotch.io)

hoppscotch.io

Happy Coding โค๏ธŽ

You canโ€™t perform that action at this time.