VentGrey / teargas

Simple REST API tester made in Go

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

๐Ÿ”ฅ Teargas - Simple REST API tester made in Go with JWT support. ๐Ÿ”๐Ÿ•ต๏ธโ€โ™‚๏ธ๐ŸŒ

Go CodeQL

My personal REST API consuming software written in Go. Teargas is a powerful yet lightweight tool designed for testing and consuming REST APIs with ease. With built-in JWT support, it's versatile and perfect for modern web development.

๐ŸŒŸ Features

  • Simple & intuitive CLI interface.
  • JWT Authentication support.
  • Simple response statistics for quick evaluations.
  • Binary is NOT small.
  • Normally compiled binary size is ~7.3MB (Yes, fuck static binaries)
  • Stripped binary is ~5.0MB (Yep...)

๐Ÿšจ Copyright disclaimer

This software name and thumbnail don't intend to infringe copyright laws by illegally copying or claiming content that isn't mine. This is made solely as a tribute to the artists/bands I like, the original idea + artwork concept and registered trademarks are property of said artist and their registered trademark holders. ๐Ÿšซ๐Ÿ‘ฎโ€โ™‚๏ธ๐Ÿ”’๐Ÿ’ผ

Source inspiration taken from: Teargas - Katatonia. ๐ŸŽต๐ŸŽค๐ŸŽง

๐Ÿš€ Getting started

Prerequisites

  • Go 1.16 or higher ๐Ÿš€
  • A simple REST API to consume ๐ŸŒ

Installation

Download the latest version from the releases page

or

  1. Clone the repo
git clone https://github.com/VentGrey/teargas.git
  1. Build the binary
cd teargas

# Build a normally compiled binary
go build -o teargas teargas.go

# Build a "stripped" binary
go build -o teargas -ldflags="-s -w" teargas.go
  1. Run the program
./teargas -url <URL> -output [output file]
  1. (Optionally build a Debian Package)

Since dh-make-golang is walking crap. The method for building a Debian Package here is similar to the one used in Linux Mint.

๐Ÿค– Usage

Basic usage:

teargas -url <URL> -output [output file]

Make a request using JWT authentication:

teargas -url <URL> -output [output file] -username <USERNAME> -password <YOURPASSWORD> -authurl <AUTH_URL>

๐Ÿค Contributing

Contributions are always welcome! ๐Ÿค—...however I think this doesn't need much tho. Feel free to propose any changes you'd like :)

๐Ÿ› Bugs

Please report any bugs to omar@laesquinagris.com ๐Ÿ“ง๐Ÿ›

๐Ÿ“œ License

Distributed under the GPL-2+ License. See LICENSE for more information. ๐Ÿ“œ๐Ÿ“

๐Ÿ“– References

About

Simple REST API tester made in Go

License:GNU General Public License v2.0


Languages

Language:Go 61.1%Language:Roff 38.9%