Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nathan-fiscaletti/galago
☝️ A simple REST framework written in Go
https://github.com/nathan-fiscaletti/galago
api api-framework go golang golang-api golang-libraries golang-library rest rest-api restful
Last synced: 1 day ago
JSON representation
☝️ A simple REST framework written in Go
- Host: GitHub
- URL: https://github.com/nathan-fiscaletti/galago
- Owner: nathan-fiscaletti
- License: other
- Created: 2020-03-22T18:47:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-04T10:25:23.000Z (almost 3 years ago)
- Last Synced: 2024-10-13T12:27:37.971Z (about 1 month ago)
- Topics: api, api-framework, go, golang, golang-api, golang-libraries, golang-library, rest, rest-api, restful
- Language: Go
- Homepage:
- Size: 188 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GalaGo
[](https://github.com/sponsors/nathan-fiscaletti)
[](https://goreportcard.com/report/github.com/nathan-fiscaletti/galago)
[](https://godoc.org/github.com/nathan-fiscaletti/galago)
GalaGo is a simple HTTP REST framework written in [Go](https://golang.org).
GalaGo aims to be a streamlined, fast and simple building block for use with any web application written in Go. See [Performance](#performance) for more information.
It's important to keep in mind that GalaGo is a high level abstraction of a lot of the built in HTTP logic provided by Go off the shelf. The main purpose of GalaGo is to work as a supporting library to those already existing features, and to abstract some of their logic to make it easier to consume. GalaGo makes a large effort to ensure that all of the lower level structures already provided by Go are always exposed through the layer of abstraction.
## Installation
```sh
$ go get github.com/nathan-fiscaletti/galago
```
```go
package main
import(
"github.com/nathan-fiscaletti/galago"
)
```
## Features
- **Written in Go**
Writing the framework in Go allows for several performance enhancements that would not regularly be available. Namely, the ability to compile directly to machine code. See [Performance](#performance) for more information. GalaGo attempts to maintain as much simplicity as possible while still providing the easiest implementation available.
- **HTTP / HTTPS**
Both HTTP and HTTPS are supported by GalaGo out of the box. See [Configure GalaGo for TLS](./tutorials/tls.md) for more information on using GalaGo with HTTPS.
- **REST Components**
GalaGo supports several generic REST components that are not regularly available in the Go HTTP libraries. These include Middleware, Routing, Controllers, Serialization and Downloads. See the [Example File](./example/) for more information.
- **Consumable as a Library**
GalaGo does not require you to run it as a stand alone binary. Importing GalaGo as a library into your existing HTTP project can be done quickly and easily to provide the same set of features available in GalaGo to your existing web package.
## Documentation, Examples & Tutorials
I've tried to compile several useful tutorials and examples for those interested in using GalaGo. Outside of that, it is kept documented to the best of my abilities.
|||
|---|---|
|[My First GalaGo Application](./tutorials/getting-started.md)|A starter application for beginners interested in learning more about GalaGo|
|[Documentation](https://godoc.org/github.com/nathan-fiscaletti/galago/)|Library documentation covering all available data structures and functions.|
|[Example File](./example/)|A file demonstrating many of the features available in GalaGo|
|[Tutorials](./tutorials)|Several tutorials going over implementing GalaGo and using GalaGo in different environments and with different Configurations.|
## Why Go?
The older version of this framework was written in PHP. This was purely based on research around what languages were most commonly used for this type of framework at the time _(nearly five years ago)_. While using PHP did allow for some more in depth configuration and for features such as editing the code without re-compiling, coupled with the bloat and other annoyances of the older framework, it did not offer the raw performance you will get out of compiling your REST API down to machine code.
## What about [mod-go](https://github.com/idaunis/mod_go)?
In the future I hope to add support for mod-go, however the project has been abandoned for quite some time and I'm still on the fence about whether or not I will add support for it.
## What about an ORM?
If you'd like to use an ORM with GalaGo to link in your database, I highly recommend looking into [gorm](https://github.com/jinzhu/gorm). It's a well maintained and highly recommended ORM for Go with over 17,000 stars. Since this library already exists and has a decent feature set and user base, I see no reason to write a new ORM for use with GalaGo.
## Performance
All tests run using a simple Hello World GalaGo application and plain HTTP.
[**Baton**](https://github.com/americanexpress/baton)
```
$ ./baton -r 200000 -c 5 -u http://localhost:8080/hello/world
Configuring to send GET requests to: http://localhost:8080/hello/world
Generating the requests...
Finished generating the requests
Sending the requests to the server...
Finished sending the requests
Processing the results...
====================== Results ======================
Total requests: 200000
Time taken to complete requests: 3.93532484s
Requests per second: 50822
===================== Breakdown =====================
Number of connection errors: 0
Number of 1xx responses: 0
Number of 2xx responses: 200000
Number of 3xx responses: 0
Number of 4xx responses: 0
Number of 5xx responses: 0
=====================================================
```
[**Bombardier**](https://github.com/codesenberg/bombardier)
```
$ ./bombardier-darwin-amd64 -c 5 -n 200000 -l http://localhost:8080/hello/world
Bombarding http://localhost:8080/hello/world with 200000 request(s) using 5 connection(s)
200000 / 200000 [==============================================================================================================================================================] 100.00% 42772/s 4s
Done!
Statistics Avg Stdev Max
Reqs/sec 44110.31 3090.28 49656.00
Latency 111.53us 16.32us 2.35ms
Latency Distribution
50% 108.00us
75% 119.00us
90% 133.00us
95% 147.00us
99% 215.00us
HTTP codes:
1xx - 0, 2xx - 200000, 3xx - 0, 4xx - 0, 5xx - 0
others - 0
Throughput: 8.75MB/s
```
## License
GalaGo is licensed under the Apache 2.0 License. See [LICENSE](./LICENSE) for more information.