Apiman

_{Built with ❤︎ by grlib and contributors}

---

API request builder

Start here: Story behind Apiman

Features ✨

❤️ Lightweight: Crafted with Ant Design and Vue

• Faster, lighter, cleaner, minimal & responsive

⚡ Real-time: Send requests and get/copy responses right away!

Methods:

• GET - Retrieve information about the REST API resource
• HEAD - Asks for a response identical to that 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
• OPTIONS - Describe the communication options for the target resource
• PATCH - Applies partial modifications to a REST API resource

History entries are synced with GitHub Gist and more

Features:

• Share with social(with password option)
• Offline support
• Sync By GitHub Gist

🚀 Request: Retrieve data from a URL without having to do a full page refresh

• Choose method
• Enter URL
• Enter Path
• Copy public "Share URL"
• Generate request code for JavaScript XHR, Fetch, cURL
• Copy generated request code to clipboard

🔌 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
• Env suppert,You can set a request's response as authentication

📢 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
• Toggle between RAW input and 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

• Timestamp
• Method
• Status code
• URL
• Path

History entries can be deleted one-by-one or all together

---

Home

https://apiman.io

Usage

1. Specify your request method
2. Type in your API URL
3. Add API path
4. Send request
5. 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!
• Electron - Build cross platform desktop apps with JavaScript, HTML, and CSS
• Vue - To add to the JavaScript magic!

---

Developing

1. Clone this repo with git.
2. Install dependencies by running yarn within the directory that you cloned (probably apiman).
3. Start the development server with yarn dev.

---

Releasing

1. Clone this repo with git.
2. Install dependencies by running npm install within the directory that you cloned (probably apiman).
3. Build the release files with npm run build.
4. 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 GRLib 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

• GRLib - Author

Testing and Debugging

• GRLib
• (contributors)

apiman

apiman is a desktop app like Postman, But more smart