mirror of
https://github.com/foss42/apidash.git
synced 2025-10-09 23:37:14 +08:00
139 lines
5.8 KiB
Markdown
139 lines
5.8 KiB
Markdown
# API Dash ⚡️
|
|
|
|
[](https://bit.ly/heyfoss)
|
|
|
|
### Please support this initiative by giving this project a Star ⭐️
|
|
|
|
API Dash is a beautiful open-source cross-platform API Client that can help you easily create & customize your API requests, visually inspect responses and generate Dart code on the go.
|
|
|
|
## Download
|
|
API Dash can be downloaded from the links below:
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>OS</th>
|
|
<th>Distribution</th>
|
|
<th>Installation Guide</th>
|
|
<th>CPU/Architecture</th>
|
|
<th>Download Link</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>macOS</td>
|
|
<td><code>.dmg</code></td>
|
|
<td><a href="https://github.com/foss42/apidash/blob/main/INSTALLATION.md#macos">Link</a></td>
|
|
<td>Apple Silicon & Intel</td>
|
|
<td><a href="https://bit.ly/44wmazf">Link</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Windows</td>
|
|
<td><code>.exe</code></td>
|
|
<td><a href="https://github.com/foss42/apidash/blob/main/INSTALLATION.md#windows">Link</a></td>
|
|
<td>64-bit</td>
|
|
<td><a href="https://bit.ly/424ExKb">Link</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td rowspan=4>Linux</td>
|
|
<td rowspan=2><code>.deb</code></td>
|
|
<td rowspan=2><a href="https://github.com/foss42/apidash/blob/main/INSTALLATION.md#debian-based-linux-distributions-debian-ubuntu-linux-mint-etc">Link</a></td>
|
|
<td>amd64</td>
|
|
<td><a href="https://bit.ly/44sWPq2">Link</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>arm64</td>
|
|
<td><a href="https://bit.ly/3pdVgvP">Link</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td rowspan=2><code>.rpm</code></td>
|
|
<td rowspan=2><a href="https://github.com/foss42/apidash/blob/main/INSTALLATION.md#red-hat-based-linux-distributions-fedora-rocky-almalinux-centos-rhel-etc">Link</a></td>
|
|
<td>x86_64</td>
|
|
<td><a href="https://bit.ly/417gWHe">Link</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>aarch64</td>
|
|
<td><a href="https://bit.ly/3LWdJWV">Link</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
## A Quick Glimpse of API Dash ⚡️ (Demo Video)
|
|
|
|
Demo Video on Youtube - [Link](https://youtu.be/IQlrgpNpS2s) (In case there is an error loading the embedded video below 👇)
|
|
|
|
https://github.com/foss42/apidash/assets/615622/fccc569e-3152-47be-9f94-ceb851ee85a0
|
|
|
|
## List of Features
|
|
|
|
**↗️ Create & Customize API Requests**
|
|
- Create different types of HTTP requests (`GET`, `HEAD`, `POST`, `PATCH`, `PUT` and `DELETE`)
|
|
- Easily manipulate and play around with request inputs like `headers`, `query parameters` and `body`.
|
|
- Full support to send text content with 🥳 Unicode/Emoji and preview any API response containing Unicode/Emoji.
|
|
|
|
**🔎 Visually Inspect and Download API Responses**
|
|
- Inspect the API Response (HTTP status code, error message, headers, body, time taken)
|
|
- View formatted code previews for responses of various content types like `JSON`, `XML`, `YAML`, `HTML`, `SQL`, etc.
|
|
- Supports directly previewing these a wide variety of 🖼 image file formats such as `jpeg`, `png`, `gif`, etc.
|
|
- Save 💾 response body of any mimetype (`image`, `text`, etc.) directly in the `Downloads` folder of your system by clicking on the `Download` button.
|
|
|
|
**👩🏻💻 Code Generation**
|
|
- The **only** open source API client that supports advanced Dart code generation so that you can easily integrate APIs in your Dart/Flutter project or directly run it on DartPad.
|
|
|
|
**🌙 Full Dark Mode Support**
|
|
- Easily switch between light mode and dark mode.
|
|
|
|
**💼 Organize Requests in Collection Pane**
|
|
- Press and Drag to Re-arrange requests.
|
|
- Double-click to rename requests.
|
|
- Click and open popup menu to duplicate and delete a request.
|
|
|
|
**💾 Data**
|
|
- Data is persisted locally on the disk. To save the current snapshot, just press the **Save** button in the collection pane.
|
|
|
|
**⚙️ Settings & Other Options**
|
|
- Customize various options using a dedicated Settings screen.
|
|
- Window Configuration (Size & Position) is persisted and restored on app start. (Only macOS & Windows)
|
|
|
|
## Code Generators
|
|
|
|
API Dash currently supports API integration code generation for the following languages/libraries.
|
|
|
|
|Language|Library|
|
|
|--|--|
|
|
| cURL | |
|
|
| HAR | |
|
|
| Dart | `http` |
|
|
| JavaScript | `axios` |
|
|
| JavaScript | `fetch` |
|
|
| JavaScript (`node.js`) | `axios` |
|
|
| JavaScript (`node.js`) | `fetch` |
|
|
| Python | `http.client` |
|
|
| Python | `requests` |
|
|
| Kotlin | `okhttp3` |
|
|
|
|
We welcome contributions to support other programming languages/libraries/frameworks. Please check out more details [here](https://github.com/foss42/apidash/discussions/80).
|
|
|
|
## What's new in v0.2.0?
|
|
|
|
Visit [CHANGELOG.md](CHANGELOG.md)
|
|
|
|
## Provide Feedback, Report Bugs & Request New Features
|
|
|
|
Just click on the [Issue tab](https://github.com/foss42/apidash/issues) to raise a new issue in this repo.
|
|
|
|
## Contribute to API Dash
|
|
|
|
You can contribute to API Dash in any or all of the following ways:
|
|
|
|
- [Ask a question](https://github.com/foss42/apidash/discussions)
|
|
- [Submit a bug report](https://github.com/foss42/apidash/issues/new/choose)
|
|
- [Request a new feature](https://github.com/foss42/apidash/issues/new/choose)
|
|
- [Suggest ways to improve the developer experience of an existing feature](https://github.com/foss42/apidash/issues/new/choose)
|
|
- Add documentation
|
|
- To add a new feature, resolve an existing issue or add a new test to the project, check out our [Contribution Guidelines](CONTRIBUTING.md).
|
|
|
|
## Need Any Help?
|
|
|
|
In case you need any help with API Dash or are encountering any issue while running the tool, please feel free to drop by our [Discord server](https://bit.ly/heyfoss) and we can have a chat in the **#foss** channel.
|