Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/go-gorf/gorf
Django inspired Golang Rest Framework
https://github.com/go-gorf/gorf
framework gin go golang gorf rest-api
Last synced: about 1 month ago
JSON representation
Django inspired Golang Rest Framework
- Host: GitHub
- URL: https://github.com/go-gorf/gorf
- Owner: go-gorf
- License: mit
- Created: 2023-04-02T19:09:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-09T19:13:12.000Z (about 1 year ago)
- Last Synced: 2024-09-28T18:20:43.313Z (about 2 months ago)
- Topics: framework, gin, go, golang, gorf, rest-api
- Language: Go
- Homepage: https://go-gorf.github.io/
- Size: 83 KB
- Stars: 19
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Golang Rest Framework (Gorf)
[](https://github.com/go-gorf/gorf/actions?workflow=build)
[](https://pkg.go.dev/github.com/go-gorf/gorf)
Django inspired Rest Framework for Golang.
## Vision
Introducing Gorf, the Golang REST API framework that empowers developers to easily create and reuse modular apps.
Inspired by the simplicity and flexibility of Python Django, Gorf utilizes the full MVC architecture, providing
dedicated model, URL, and view files for effortless understanding. Gorf's plug and play app concept enables infinite
scalability and customization, making Gorf the go-to solution for anyone looking to kickstart a new project in Golang.
Join our community and contribute your ideas and innovations to build a framework that streamlines the development process for all.
Features
* Generic
* Simplicity
* Based on known architecture
* Reusability
* Support for apps
* Custom database backends
* More feature work in progress
## Installation
```bash
go get github.com/go-gorf/gorf
```
Install gorf auth app
```bash
go get github.com/go-gorf/auth
```
## Tutorial
Firstly, Create a new main package with following code
``` go
package main
import (
"log"
)
func main() {
r := BootstrapRouter()
err := r.Run()
if err != nil {
log.Fatal("Unable to create the gin server")
} // listen and serve on 0.0.0.0:8080 (for windows "localhost:8080")
}
```
## settings.go
Next, Create a settings.go file in the main package with the following code snippet
``` go title="settings.go"
package main
import (
"github.com/gin-gonic/gin"
"github.com/go-gorf/auth"
"github.com/go-gorf/gorf"
)
// add all the apps
var apps = []gorf.GorfApp{
&auth.AuthApp,
}
func LoadSettings() {
// jwt secret key
gorf.Settings.SecretKey = "GOo8Rs8ht7qdxv6uUAjkQuopRGnql2zWJu08YleBx6pEv0cQ09a"
gorf.Settings.DbConf = &gorf.SqliteBackend{
Name: "db.sqlite",
}
}
// bootstrap server
func BootstrapRouter() *gin.Engine {
gorf.Apps = append(apps)
LoadSettings()
gorf.InitializeDatabase()
gorf.SetupApps()
r := gin.Default()
gorf.RegisterApps(r)
return r
}
```
## Write your own apps
Create a new package named "hello"
add app.go file
``` go
package hello
import (
"github.com/go-gorf/gorf"
)
func setup() error {
// Add setup here
return nil
}
var HelloApp = gorf.GorfBaseApp{
Name: "Hello",
RouteHandler: Urls,
SetUpHandler: setup,
}
```
add urls.go file
``` go
package hello
import "github.com/gin-gonic/gin"
func Urls(r *gin.Engine) {
r.POST("/hello", Hello)
}
```
add views.go file
``` go
package hello
import (
"github.com/gin-gonic/gin"
"net/http"
)
func Hello(ctx *gin.Context) {
ctx.JSON(http.StatusOK, gin.H{
"message": "Hello world",
})
}
```
## Check the Gorf project template
[https://github.com/go-gorf/template](https://github.com/go-gorf/template)