Welcome to the Go-API Framework Wiki! This comprehensive documentation will help you understand, use, and contribute to the Go-API framework.
- Architecture Design - Comprehensive overview of the framework's layered architecture, design patterns, and core components
- Development Guide - Complete guide for developers including setup, workflow, and best practices
- Quick Start Guide - Get up and running with Go-API in minutes
- Project Setup - Detailed setup instructions for different environments
- Development Guide - Step-by-step development workflow
- Code Generator Guide - Powerful SQL-to-Go code generation tool
- Deployment Guide - Production deployment with Docker and Kubernetes
- API Documentation - Complete API reference with examples
- Authentication - JWT-based authentication system
- Code Generation - Automatic model and repository generation
- Middleware System - Custom middleware development
- Configuration Management - Multi-environment configuration
- Makefile Usage - Complete guide to using Makefile for development
- go-api.sh Usage - Shell script alternative to Makefile
- Docker Deployment - Containerized deployment guide
- Kubernetes - Cloud-native deployment
- Monitoring & Logging - Production monitoring setup
| Topic | Description | Link |
|---|---|---|
| Getting Started | New to Go-API? Start here | Quick Start |
| Architecture | Understand the framework design | Architecture Design |
| Development | Learn development workflow | Development Guide |
| API Reference | API endpoints and usage | API Documentation |
| Code Generation | Automatic code generation | Code Generator |
| Deployment | Production deployment | Deployment Guide |
| Makefile | Build automation guide | Makefile Usage |
| Shell Script | Alternative build script | go-api.sh Usage |
- 🚀 High Performance - Built on Gin framework with optimized components
- 🏗️ Layered Architecture - Clean separation of concerns with Model → Repository → Service → Controller pattern
- 🔧 Dependency Injection - Proper DI implementation for better testability
- ⚙️ Configuration Management - Multi-environment configuration support
- 📝 Advanced Logging - Structured logging with Zap
- 🗄️ Multi-Database - MySQL (GORM) and MongoDB (qmgo) support
- 🔐 JWT Authentication - Built-in secure authentication system
- 🌐 Internationalization - Multi-language support (Chinese, English)
- 🎛️ Middleware System - Comprehensive middleware for CORS, auth, logging
- ⚡ Code Generation - Automatic model/repository generation from SQL
- 📊 Monitoring - Built-in monitoring and alerting capabilities
graph TD
A[Create SQL Schema] --> B[Run Code Generator]
B --> C[Implement Service Logic]
C --> D[Create Controllers]
D --> E[Register Routes]
E --> F[Write Tests]
F --> G[Deploy]
- GitHub Repository - Source code and issues
- Go Documentation - Official Go documentation
- Gin Framework - Web framework documentation
- GORM - ORM library documentation
We welcome contributions! Please see our Contributing Guidelines for details on:
- Code standards and style guide
- Pull request process
- Issue reporting
- Development setup
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Email: seakee23@gmail.com
This project is licensed under the MIT License - see the LICENSE file for details.