GoFast

GoFast is a powerful Go framework designed to streamline the development of APIs by generating request validation, binding, and OpenAPI documentation at build time rather than at runtime. This proactive approach eliminates the need for runtime reflection, significantly improving performance and reducing memory allocations.

Key Features

• Build-Time Automation: Structs annotated with tags are processed once at build time, allowing GoFast to produce readable Go code that manages validation, binding, and documentation effortlessly. This results in more predictable and maintainable code.

• Performance: Benchmarked against other frameworks, GoFast provides approximately 37.5 times faster isolated validation with 26% fewer memory allocations than alternatives like Huma.

Overview of Functionality

1. Struct Definition: Developers define their request and response structures using tags for validation and binding.

   type LoginInput struct {
       Email    string `json:"email" validate:"required,email"`
       Password string `json:"password" validate:"required,min=8"`
   }
   

2. Code Generation: Utilizing the command line interface, a simple command generates the necessary validation and binding functions for the application. For example:

   go run ./cmd/gofast generate ./main.go
   

   This creates real Go code that implements validation for the defined structs, making it both auditable and maintainable.

3. OpenAPI Documentation: Automatically documents all registered routes, enabling easy access to an interactive Swagger UI for API exploration:

   router.ServeOpenAPI("/openapi.json", "My API", "1.0.0")
   router.ServeSwaggerUI("/docs", "/openapi.json")
   

   This integration ensures that documentation stays in sync with the API implementation.

4. Error Handling and Middleware Support: GoFast incorporates structured error handling to prevent internal errors from leaking to clients. It also supports various middleware functionalities, including logging and health checks.

Project Status

Currently in active development, GoFast is pre-v1.0.0. The project is continuously evolving, with a transparent roadmap detailing features and architectural decisions. All aspects of development, including performance benchmarks and code quality checks, are rigorously maintained.

For a comprehensive understanding of what GoFast offers, including architecture details and performance evidence, refer to the documentation available in the repository.