Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bartkessels/GetIt
Application to send HTTP requests to test your API endpoints.
https://github.com/bartkessels/GetIt
client cpp cpprestsdk getit http linux macos qt rest syntax-highlighting windows
Last synced: about 2 months ago
JSON representation
Application to send HTTP requests to test your API endpoints.
- Host: GitHub
- URL: https://github.com/bartkessels/GetIt
- Owner: bartkessels
- License: mit
- Created: 2017-03-28T20:59:38.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2022-12-21T18:11:26.000Z (over 1 year ago)
- Last Synced: 2024-07-23T02:42:00.094Z (about 2 months ago)
- Topics: client, cpp, cpprestsdk, getit, http, linux, macos, qt, rest, syntax-highlighting, windows
- Language: C++
- Homepage: https://getit.bartkessels.net
- Size: 56.5 MB
- Stars: 51
- Watchers: 5
- Forks: 6
- Open Issues: 14
-
Metadata Files:
- Readme: readme.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GetIt
Open Source HTTP client to test your API's.
[](https://opensource.org/licenses/MIT)
[](https://github.com/bartkessels/GetIt/actions/workflows/build_and_test.yml)
[](https://www.codacy.com/gh/bartkessels/GetIt/dashboard?utm_source=github.com&utm_medium=referral&utm_content=bartkessels/GetIt&utm_campaign=Badge_Grade)
[](https://github.com/bartkessels/GetIt/actions/workflows/codeql-analysis.yml)
[](https://github.com/bartkessels/GetIt/actions/workflows/macos_bundle.yml)
[](https://github.com/bartkessels/GetIt/actions/workflows/windows_executable.yml)
[](https://github.com/bartkessels/GetIt/actions/workflows/linux_flatpak.yml)
---
Welcome to the Git repository of GetIt. GetIt is a small open source application to send API
request using a cross-platform GUI. The main advantage of GetIt is the fact that it's native, no
matter what platform you use, and it's completely open source.
# Table of contents
- [1. Overview](#1-overview)
- [1.1 Sharing requests](#11-sharing-requests)
- [1.2 Roadmap](#12-roadmap)
- [2. External dependencies](#2-external-dependencies)
- [3. Build](#3-build)
- [3.1 MacOS](#31-macos)
- [3.2 Linux](#32-linux)
- [3.3 Windows](#33-windows)
- [4. Package](#4-package)
- [4.1 MacOS](#41-macos)
- [4.2 Linux](#42-linux)
- [4.3 Windows](#43-windows)
- [5. Automated testing](#5-automated-testing)
- [6. Contribute](#6-contribute)
- [6.1 Branching strategy](#61-branching-strategy)
# 1. Overview
GetIt's main focus is providing an easy user interface to send HTTP request to your API endpoints.
GetIt is developed for developers who'd like a native application which is capable of saving requests
in a modern file format.
## 1.1 Sharing requests
GetIt uses the JSON-format to store request information, however, when you've got a request that uses
files these files aren't incorporated into the GetIt request file.
The main features of GetIt compared to the alternatives are the way requests can be shared. There are
other applications which let's you synchronise a number of requests using a proprietary cloud solution
with a subscription. In the design of GetIt we took the sharing of requests very seriously but since we're not
an entire company we can't setup an entire cloud solution. Thus we've made sure the file contents are human readable
an easy to check-in using VCS.
## 1.2 Roadmap
Because GetIt is maintained in the spare time, not all features that we'd like are implemented as of yet.
Some of the features we'd like to see in GetIt are listed below. These features are also added as issues
on GitHub so the status can be viewed in the projects tab.
- Multiple authentication flows
- OAuth
- JWT
- Basic Auth
- Environment variables
- Variables that are stored in the request itself
- Variables that are stored in the settings of GetIt
- To allow API secrets to be stored, but not checked into VCS
- Automated stress testing
# 2. External dependencies
GetIt uses CMake to download and compile most of it's dependencies. However, not all dependencies
are aviable through this method so these need to be installed on the machine itself before compiling.
When downloading and executing a pre-built release from the Releases tab on Github, these dependencies
aren't required.
- [Qt](https://qt.io)
- The GUI framework used by GetIt
- [Boost](https://boost.org)
- Helper libraries for formatting strings and used by [CppRestSdk](https://github.com/microsoft/cpprestsdk), which in turn is used by GetIt as the HTTP library
- [Ninja](https://ninja-build.org)
- Cross-platform build system
- [CMake](https://cmake.org)
- Cross-platform build tool generator
# 3. Build
## 3.1 MacOS
```bash
# Disable warnings as error, these warning are from the CppRestSdk dependency
$ cmake . -G Ninja -D CMAKE_CXX_FLAGS="-w"
$ ninja GetIt
```
This will create the `./bin/GetIt.app` file. This can be executed by double-clicking it in Finder.
Please note that this app bundle does __NOT__ include the dependencies or the Qt framework. When you move
the bundle to a different location on your computer (or another computer altogether) the application might not start.
## 3.2 Linux
__NOT TESTED YET!__
The following steps have not been tested yet, if you follow these steps, and it works, please open a PR
to remove this warning. If these steps don't work, and you've got a working solution. Please also open a PR to
include your steps here.
```bash
$ cmake . -G Ninja
$ ninja GetIt
```
This will create the `./bin/GetIt` binary file. It can be executed by either running `./bin/GetIt` from the terminal
or double-clicking the file through your file browser.
## 3.3 Windows
__NOT TESTED YET!__
The following steps have not been tested yet, if you follow these steps, and it works, please open a PR
to remove this warning. If these steps don't work, and you've got a working solution. Please also open a PR to
include your steps here.
```bash
$ cmake . -G Ninja
$ ninja GetIt
```
This will create the `./bin/GetIt.exe` executable. It can be executed by double-clicking the file from Explorer.
# 4. Package
## 4.1 MacOS
Build the MacOS app bundle with all dependencies and framework included by running the `package.sh` script
in the MacOS packaging folder.
```bash
$ zsh ./packaging/macos/package.sh
```
This will create the `./bin/GetIt.app` app bundle with all required dependencies. This file can be distributed across
multiple systems.
## 4.2 Linux
This is not completed yet, there is going to be a script to generate a flatpak bundle.
## 4.3 Windows
This is not completed yet, there is going to be a script to generate a Windows executable file.
# 5. Automated testing
To validate that GetIt works, and keeps working through various updates GetIt includes automated unit
tests using [Catch2](https://github.com/catch/catch2). These tests are automatically executed when you create
a PR or when directly pushing to the main branch (which should __NEVER__ be done!).
To execute these tests manually you need to specify the `getit_tests` build target.
```bash
$ cmake . -G Ninja
$ ninja getit_tests
# Execute the test cases
$ ./bin/getit_tests
```
This will generate an application that will test GetIt when executed.
# 6. Contribute
If there's a feature you'd like to see, or a bug you've encountered? Please let us know! Or, even better, fix it
yourself! If you'd just like to contribute back to GetIt but you're not quite sure how to help, take a look at the roadmap
for features we'd love to see in GetIt.
All contributions are welcome, so feel free to join the open source community and support GetIt through your expertise!
To make sure everyone can contribute to GetIt we value the quality and understandability of our code. When you're building
a feature, or patching a bug and you've made a decision. Please document this decision in the [`docs/design.md`](docs/design.md) document.
This will help future contributors understand your rationale. If you've updated some logic in the code, please always update related
test cases or add test cases to test your logic.
## 6.1 Branching strategy
You've got your idea to help us out, but you're not quite sure how to setup your branch. We'll we've got you covered!
This project does not use a development branch but uses short lived feature branches which are directly merged into `main`.
We've chosen this strategy 'cause we believe in _release often, release fast_, there's no need for your feature to gather dust in
a stale development branch. However we do have some guidelines:
- If you're contributing a __feature__ use the `feature/` naming convention
- If you're contributing a __bug fix__ use the `bugfix/` naming convention
- If you're contributing to __documentation__ use the `documentation/` naming convention
- If you're contributing a __small fix__, like a version bump to a dependency, use the `hotfix/-` naming convention