mirrors/hoppscotch
1
0
Fork 0
mirror of https://github.com/hoppscotch/hoppscotch synced 2024-11-22 07:01:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
95547108bf
hoppscotch/README.md
liyasthomas 95547108bf docs: updated wiki links
2021-08-19 22:38:50 +05:30

14 KiB
Raw Blame History

Hoppscotch Logo

Hoppscotch

Open source API development ecosystem

contributions welcome Website Tests Tweet

Built with ❤︎ by contributors


Screenshot

Contact

Chat on Discord Chat on Telegram

Table of contents

Features

❤️ Lightweight: Crafted with minimalistic UI design.

⚡️ Fast: Send requests and get/copy responses in real-time.

HTTP 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. Customize now ✨

Theming
  • Choose 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

Screenshot

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.

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

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

👋 Response: Contains the status line, headers and the message/response body.

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

Features
  • Unlimited collections, folders and requests
  • Nested folders
  • Export as / import from GitHub gist

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 proxy server is hosted by Hoppscotch - GitHub - Privacy Policy

📜 Pre-Request Scripts β: Snippets of code associated with a request that are executed before the request is sent.

Use-cases
  • Initialize environment variables
  • 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

🌎 i18n: Experience the app in your own language.

Usage
  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

✅ 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

🌱 Environments : Environment variables allow you to store and reuse values in your requests and scripts.

Features
  • Unlimited environments and variables
  • Initialize through 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.

Features
  • Unlimited team collections and shared requests
  • Unlimited team members
  • User roles

To find out more, please check out our Documentation.

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

Official container   hoppscotch/hoppscotch

docker run --rm --name hoppscotch -p 3000:3000 hoppscotch/hoppscotch: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 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.