Github url

postwoman

by liyasthomas

liyasthomas /postwoman

๐Ÿ‘ฝ A free, fast and beautiful API request builder (web alternative to Postman) used by 62k+ develope...

20.7K Stars 1.3K Forks Last release: about 2 months ago (v1.9.7) MIT License 2.1K Commits 7 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Postwoman.io logo

A free, fast and beautiful API request builder

Web alternative to Postman - Helps you create requests faster, saving precious time on development - Subscribe

Travis Build Status GitHub release Website Contributions welcome Financial Contributors on Open Collective Donate on PayPal Chat on Telegram Chat on Discord Tweet

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


Read: Story behind Postwoman

Chat: Telegram, Discord

Donate: GitHub Sponsors, Open Collective, Patreon, PayPal

Screenshot1

Table of contents

### Features โœจ

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

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

Methods:

  • GET
    • Retrieve information about the REST API resource
  • HEAD
    • Retrieve response headers identical to those of a GET request, but without the response body.
  • POST
    • Create a REST API resource
  • PUT
    • Update a REST API resource
  • DELETE
    • Delete a REST API 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
    • Apply partial modifications to a REST API resource
  • <custom></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: Kinda Dark (default), Clearly White, Just Black and System theme
  • Choose accent color: Green (default), Yellow, Pink, Red, Purple, Orange, Cyan and Blue
  • 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 for
    JavaScript XHR
    ,
    Fetch
    and
    cURL
  • 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:

Official Postwoman 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:

  • Send/Cancel Request Ctrl + G
  • Save to Collections Ctrl + S
  • Copy Request Link Ctrl + K
  • Reset Request Ctrl + L

๐ŸŒŽ 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 Postwoman.

  • Proxy - A simple proxy server created for Postwoman
  • CLI ฮฒ - A CLI solution for Postwoman
  • Browser Extensions - Browser extensions that simplifies access to Postwoman

Firefox Firefox  |  Chrome Chrome

**Extensions fixes

CORS

issues.**

Add-ons are developed and maintained under Official Postwoman 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 Postwoman Wiki.

Demo ๐Ÿš€ Website

postwoman.io

Usage ๐Ÿ’ก

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

Built with ๐Ÿ”ง

  • HTML - For the web framework
  • CSS - For styling components
  • JavaScript - For magic!
  • Vue
  • Nuxt

Developing ๐Ÿ‘ท

  1. Update [
    .env.example
    ](https://github.com/liyasthomas/postwoman/blob/master/.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
    postwoman
    ).
  3. Start the development server with
    npm run dev
    .
  4. Open development site by going to [
    http://localhost:3000
    ](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
    ](http://localhost:3000) in your browser.

Docker ๐Ÿณ Docker Cloud Build Status

#pull docker pull liyasthomas/postwoman #run docker run -p 3000:3000 liyasthomas/postwoman:latest #build docker build -t postwoman:latest .

Releasing ๐Ÿงž

  1. Clone this repo with git.
  2. Install dependencies by running
    npm install
    within the directory that you cloned (probably
    postwoman
    ).
  3. Build the release files with
    npm run build
    .
  4. Find the built project in
    ./dist
    .

Contributing ๐Ÿฐ

Please read [

CONTRIBUTING

](https://github.com/liyasthomas/postwoman/blob/master/CONTRIBUTING.md) for details on our [

CODE OF CONDUCT

](https://github.com/liyasthomas/postwoman/blob/master/CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.

Continuous Integration ๐Ÿ’š Travis Build Status

We use Travis CI for continuous integration. Check out our Travis CI Status.

Versioning ๐Ÿ”– GitHub release

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

Change log ๐Ÿ“

See the [

CHANGELOG

](https://github.com/liyasthomas/postwoman/blob/master/CHANGELOG.md) file for details.

Authors ๐Ÿง™

Lead Developers

Testing and Debugging

Collaborators <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

All Contributors

|
Liyas Thomas

๐Ÿ’ป ๐ŸŽจ |
John Harker

๐Ÿ’ป ๐ŸŽจ |
Nicholas La Roux

๐Ÿ’ป |
Thomas Yuba

๐Ÿ’ป |
Nick Palenchar

๐Ÿ’ป |
Andrew Bastin

๐Ÿ’ป |
Vladislav

๐Ÿ’ป | |
izerozlu

๐Ÿ’ป |
Jacob Anavisca

๐Ÿ’ป |
Nityananda Gohain

๐Ÿ’ป |
Hossein Nedaee

๐Ÿ’ป |
James George

๐Ÿ’ป |
Dmitry Yankowski

๐Ÿ’ป |
Samir Boulema

๐Ÿ’ป |

See the list of contributors who participated in this project.

Thanks

Financial Contributors

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

Organizations

Support this project with your organization. Your logo will show up here with a link to your website [Contribute].

Individuals

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

](https://github.com/liyasthomas/postwoman/blob/master/LICENSE) file for details.

Acknowledgements ๐Ÿ™

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

Badges ๐Ÿ“›

Preview Markdown code
[
](https://postwoman.io)
      Default
    </sub> | `[![Postwoman](https://img.shields.io/badge/Tested_on-Postwoman-202124?logo=Postwoman)](https://postwoman.io)` |

|

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

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

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

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

Postwoman.io

Happy Coding โค๏ธŽ

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.