Skip to content

Official documentation for goserve - a robust Go backend framework for building production-ready REST APIs.

License

Notifications You must be signed in to change notification settings

afteracademy/goserve-docs

Repository files navigation

goserve Documentation

goserve

Official Documentation for goserve Framework

Build Production-Ready REST APIs with Go

Documentation

GitHub Latest Version License


About goserve

goserve is a robust Go backend framework that provides a performant and scalable foundation for building REST APIs. It emphasizes feature separation, clean code, and testability with built-in JWT authentication and role-based authorization.

Documentation Site

goserve.afteracademy.com

Complete guides, examples, and API references for building production-ready Go applications.

What's Included

  • Feature Separation - Clean architecture with modular design
  • High Performance - Built on Go, Gin, and optimized database drivers
  • Testability - Simplified unit and integration testing
  • Security First - JWT authentication, middleware support, and secure patterns
  • Database Support - PostgreSQL (pgx) and MongoDB integrations
  • Redis Integration - Built-in caching support
  • Production Ready - Validator, Viper config, and crypto utilities
  • Example Projects - Complete implementations to get started quickly

Documentation Structure

Getting Started

Example Projects

Complete REST API with PostgreSQL, Redis, JWT authentication, role-based authorization, and comprehensive testing.

Repository: goserve-example-api-server-postgres

Complete REST API with MongoDB, Redis, and JWT authentication.

Repository: goserve-example-api-server-mongo

Microservices architecture with Kong API gateway, NATS messaging, and Docker orchestration.

Repository: gomicro

Technology Stack

  • Go 1.21+ - Modern, efficient programming language
  • Gin - Fast HTTP web framework
  • JWT (RS256) - Secure RSA-signed token-based authentication
  • pgx - PostgreSQL driver with connection pooling
  • MongoDB Driver - Official Go driver for MongoDB
  • go-redis - Redis client for caching and sessions
  • Validator - Request validation utilities
  • Viper - Configuration management
  • Docker & Docker Compose - Containerization and orchestration

Contributing to Documentation

Found an issue or want to improve the documentation?

  1. Fork this repository
  2. Create your feature branch (git checkout -b improve-docs)
  3. Commit your changes (git commit -m 'Improve documentation')
  4. Push to the branch (git push origin improve-docs)
  5. Open a Pull Request

Links

License

Apache 2.0 - See LICENSE for details


Built with ❤️ by AfterAcademy

⭐ Star the goserve framework if you find it helpful!