https://github.com/sebastiandotdev/rc
REST Client is an easy-to-use command-line tool for interacting with RESTful APIs.
https://github.com/sebastiandotdev/rc
Last synced: over 1 year ago
JSON representation
REST Client is an easy-to-use command-line tool for interacting with RESTful APIs.
- Host: GitHub
- URL: https://github.com/sebastiandotdev/rc
- Owner: openlitedotdev
- License: mit
- Created: 2024-06-25T02:17:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-13T03:28:05.000Z (almost 2 years ago)
- Last Synced: 2024-09-13T15:49:02.443Z (almost 2 years ago)
- Language: Rust
- Homepage:
- Size: 526 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Simple REST Client
Simple REST Client is an easy-to-use command-line tool for interacting with RESTful APIs. It allows you to make HTTP requests (GET, POST, PUT, DELETE, etc.) and view the responses in a clear and concise format.
**Key Features**
- Simple and intuitive
- Versatile
- Flexible
- Open-source
### Why should use Simple REST Client?
Simple REST Client can help you to be more productive by making it easier and faster to interact with RESTful APIs. This can help you to get your work done more quickly and efficiently. And even more if you are one of those people who love to use the terminal.
## Installation
## Your first RC request
Initialise a configuration file, note that this configuration file is where your base URL will be declared.
```sh
rc init
```
By default `rc` will create a file in your current folder. If you want to create a global file use the `--global` option when initialising the project.
```jsonc
// rc.config.json
{
"url": "https://jsonplaceholder.typicode.com",
"methods": [
"GET",
"POST",
"DELETE",
"PUT",
"PATCH"
],
"env": "Local",
"headers": {
"Authorization": "Bearer ",
"Content-Type": "application/json"
}
}
```
For now rc will only support JSON, it is planned that in future versions we will be able to add support for other files such as `.yaml` and `.toml`. After initialising the project you can use command like `get` to make a data request.
```sh
rc get todos --id 1
{
"userId": 1,
"id": 1,
"title": "delectus aut autem",
"completed": false
}
```
## How do I read the documentation?
> [!NOTE]
> This documentation is in constant work. If you would like to contribute write to me on [X](https://x.com/sebastiandotdev)
> Code-related documentation can be found in the [docs](./docs/) folder.
## Contributing
We appreciate your help! To contribute, please read our [build instructions](./docs/BuildInstructions.md).
## License
RC is under the **MIT** license.