When I wrote this, only God and I understood what I was doing. Now, only God knows.
Postwoman.io
API request builder - Helps you create your requests faster, saving you precious time on your development - Subscribe for updates
Built with โค๏ธ by liyasthomas and contributors
Start here: Story behind Postwoman
Donate here: PayPal, Open Collective, Patreon
Features โจ
โค๏ธ Lightweight: Crafted with minimalistic UI design. Simple design is the best design.
- Faster, lighter, cleaner, minimal & responsive
โก๏ธ Fast: Send requests and get/copy responses in real-time! Fast software is the best software.
Methods:
GET
- Retrieve information about the REST API resourceHEAD
- Asks for a response identical to that of a GET request, but without the response body.POST
- Create a REST API resourcePUT
- Update a REST API resourceDELETE
- Delete a REST API resource or related componentOPTIONS
- Describe the communication options for the target resourcePATCH
- Applies partial modifications to a REST API resource
History entries are synced with local session storage
๐ Make it yours: Customizable combinations for background, foreground and accent colors: because customization === freedom. Customize now โจ.
Customizations:
- 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 frames
Customized themes are also 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 (button in footer)
- Desktop PWA support (button in footer)
- Full features
๐ Request: Retrieve data from a URL without having to do a full page refresh.
- Choose
method
- Enter
URL
- Enter
Path
Features:
- Copy/share public "Share URL"
- Generate request code for JavaScript XHR, Fetch and cURL
- Copy generated request code to clipboard
- Import cURL
- Label requests
๐ Web Socket: Establish full-duplex communication channels over a single TCP connection.
- Send and receive data
๐ Authentication: Allows to identity the end user.
Types:
- None
- Basic authentication using username and password
- Token based authentication
๐ข Headers: Describes the format the body of your request is being sent as.
- Add or remove Header list
๐ซ 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
- View preview for HTML responses
HTML responses have "Preview HTML" feature
โฐ History: Request entries are synced with local session storage to reuse with a single click.
Fields
- Label
- Timestamp
- Method
- Status code
- URL
- Path
History entries can be sorted by any fields
Histories can deleted one-by-one or all together
Demo ๐
Usage ๐ก
- Specify your request method
- Type in your API URL
- Add API path
- Send request
- Get response!
You're done!
Built with ๐ง
- Chromium - Thanks for being so fast!
- HTML - For the web framework
- CSS - For styling components
- JavaScript - For magic!
- Vue - To add to the JavaScript magic!
- Nuxt - To add to the Vue magic!
Developing ๐ท
- Clone this repo with git.
- Install dependencies by running
npm install
within the directory that you cloned (probablypostwoman
). - Start the development server with
npm run dev
. - Open development site by going to http://localhost:3000 in your browser.
Or, with docker-compose:
- Clone this repo with git.
- Run
docker-compose up
- Open development site by going to http://localhost:3000 in your browser.
Docker ๐ณ
#pull
docker pull liyasthomas/postwoman
#run
docker run -p 3000:3000 liyasthomas/postwoman:latest
#build
docker build -t postwoman:latest
Releasing ๐ท๏ธ
- Clone this repo with git.
- Install dependencies by running
npm install
within the directory that you cloned (probablypostwoman
). - Build the release files with
npm run build
. - Find the built project in
./dist
.
Contributing ๐ฐ
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.
Change log ๐
See the CHANGELOG file for details.
Authors ๐ฎ
Lead Developers
- Liyas Thomas - Author
Testing and Debugging
Collaborators
John Harker ๐ป |
izerozlu ๐ป |
Andrew Bastin ๐ป |
Nick Palenchar ๐ป |
Thomas Yuba ๐ป |
Nicholas La Roux ๐ป |
Jacob Anavisca ๐ป |
Nityananda Gohain ๐ป |
See the list of contributors who participated in this project.
Thanks
Contributors ๐ธ
Code Contributors
This project exists thanks to all the people who contribute. [Contribute].
Financial Contributors
Become a financial contributor and help us sustain our community. [Contribute]
Individuals
Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
License ๐
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments ๐
- Hat tip to anyone who's code was used
- Inspirations: