Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Clivern/Poodle
🔥 A fast and beautiful command line tool to build API requests.
https://github.com/Clivern/Poodle
api-requests clivern command-line-tool developer-tools golang-application golang-tool hacktoberfest poodle
Last synced: about 2 months ago
JSON representation
🔥 A fast and beautiful command line tool to build API requests.
- Host: GitHub
- URL: https://github.com/Clivern/Poodle
- Owner: Clivern
- License: mit
- Created: 2020-06-21T18:22:14.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-14T21:44:24.000Z (3 months ago)
- Last Synced: 2024-07-09T01:18:54.377Z (3 months ago)
- Topics: api-requests, clivern, command-line-tool, developer-tools, golang-application, golang-tool, hacktoberfest, poodle
- Language: Go
- Homepage:
- Size: 5.38 MB
- Stars: 134
- Watchers: 5
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Poodle
A fast and beautiful command line tool to build API requests
:unicorn: Check out the full Demo!
Poodle is an interactive command line tool to build and test web APIs based on a pre-built definitions.
`Poodle` has the following features:
- Register your web services and endpoints easily.
- Use variables in endpoints definitions.
- Painless debugging and interaction with APIs.
- Search web services and endpoints interactively.
- Edit services and endpoints easily ([config is just a TOML file](/misc/service_definition.toml)).
- Sync services via Gist automatically.
## Documentation
Download [the latest poodle binary](https://github.com/Clivern/Poodle/releases). Also install [fzf](https://github.com/junegunn/fzf) for better searching otherwise poodle will use a built-in one. Make it executable from everywhere.
```zsh
$ curl -sL https://github.com/Clivern/Poodle/releases/download/x.x.x/poodle_x.x.x_OS.tar.gz | tar xz
```
To list all commands and options
```zsh
$ poodle help
A fast and beautiful command line tool to build API requests
If you have any suggestions, bug reports, or annoyances please report
them to our issue tracker at
Usage:
poodle [command]
Available Commands:
call Interact with one of the configured services
configure Configure Poodle
delete Delete a service definition file
edit Edit service definition file
help Help about any command
license Print the license
new Creates a new service definition file
sync Sync services definitions
version Print the version number
Flags:
-c, --config string config file (default "/Users/Clivern/poodle/config.toml")
-h, --help help for poodle
-v, --verbose verbose output
Use "poodle [command] --help" for more information about a command.
```
To configure poodle, You will need to provide your github username and oauth token with a `gist` scope if you need the backup/sync feature
```zsh
$ poodle configure
```
To sync definitions with backend. for now only github gists supported
```zsh
$ poodle sync
```
To create a new service.
```zsh
$ poodle new
```
by default we use `https://httpbin.org` as service API for testing so change with your web service API.
To edit a previously created service file:
```zsh
$ poodle edit
```
To start calling your services endpoints:
```zsh
$ poodle call
```
To start calling a custom service endpoints without storing it globally:
```zsh
# Assuming that .poodle.toml exists on current dir
$ poodle call -f ./.poodle.toml
```
To delete a service definition file:
```zsh
$ poodle delete
```
For more info how to create an API service definition, [please check this file.](/misc/service_definition.toml)
## Upgrade Notes
To upgrade from version `1.x.x` to version `2.x.x`, It is recommended to delete the remote github gist and poodle will sync changes in a new proper way.
## Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, Poodle is maintained under the [Semantic Versioning guidelines](https://semver.org/) and release process is predictable and business-friendly.
See the [Releases section of our GitHub project](https://github.com/clivern/poodle/releases) for changelogs for each release version of Poodle. It contains summaries of the most noteworthy changes made in each release.
## Bug tracker
If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/clivern/poodle/issues
## Security Issues
If you discover a security vulnerability within Poodle, please send an email to [[email protected]](mailto:[email protected])
## Contributing
We are an open source, community-driven project so please feel free to join us. see the [contributing guidelines](CONTRIBUTING.md) for more details.
## License
© 2020, Clivern. Released under [MIT License](https://opensource.org/licenses/mit-license.php).
**Poodle** is authored and maintained by [@clivern](http://github.com/clivern).