fastapi

README

go-fastapi

go-fastapi is a library to quickly build APIs. It is inspired by Python's popular FastAPI library.

Features:

• Auto-generated OpenAPI/Swagger schema without any markup
• Declare handlers using types, not just Context
• Based on gin framework

Installation: go get github.com/sashabaranov/go-fastapi

Example

package main

import (
	"github.com/gin-gonic/gin"
	"github.com/sashabaranov/go-fastapi"
)

type EchoInput struct {
	Phrase string `json:"phrase"`
}

type EchoOutput struct {
	OriginalInput EchoInput `json:"original_input"`
}

func EchoHandler(ctx *gin.Context, in EchoInput) (out EchoOutput, err error) {
	out.OriginalInput = in
	return
}

func main() {
	r := gin.Default()

	myRouter := fastapi.NewRouter()
	myRouter.AddCall("/echo", EchoHandler)

	r.POST("/api/*path", myRouter.GinHandler) // must have *path parameter
	r.Run()
}

// Try it:
//     $ curl -H "Content-Type: application/json" -X POST --data '{"phrase": "hello"}' localhost:8080/api/echo
//     {"response":{"original_input":{"phrase":"hello"}}}

To generate OpenAPI/Swagger schema:

myRouter := fastapi.NewRouter()
myRouter.AddCall("/echo", EchoHandler)

swagger := myRouter.EmitOpenAPIDefinition()
swagger.Info.Title = "My awesome API"
jsonBytes, _ := json.MarshalIndent(swagger, "", "    ")
fmt.Println(string(jsonBytes))

Documentation

Index

• type Router
  • func NewRouter() *Router
  • func (r *Router) AddCall(path string, handler interface{})
  • func (r *Router) EmitOpenAPIDefinition() openapi.Swagger
  • func (r *Router) GinHandler(c *gin.Context)

Types

type Router

type Router struct {
	// contains filtered or unexported fields
}

func NewRouter

func NewRouter() *Router

func (*Router) AddCall

func (r *Router) AddCall(path string, handler interface{})

func (*Router) EmitOpenAPIDefinition

func (r *Router) EmitOpenAPIDefinition() openapi.Swagger

func (*Router) GinHandler

func (r *Router) GinHandler(c *gin.Context)