Snail - Enterprise-level Microservice Rapid Development Scaffold

Quick Start • Documentation • Contributing •

🐌 Snail - Lightweight Spring Boot Rapid Development Scaffold

Snail is a modern microservices rapid development framework based on Spring Boot 3,

providing out-of-the-box authentication, authorization, gateway, resource service and other core capabilities to help enterprises quickly build secure, scalable cloud-native applications.

🚀 Out-of-the-box | Secure & Reliable | Easily Extensible | Fullstack Integration

🌟 Features

• ✅ Latest Technology Stack: Spring Boot 3.5.5 + Spring Cloud 2025.0.0 +

• 🔐 OAuth2 Authentication & Authorization: Integrated Spring Security + JWT, supports unified identity authentication and fine-grained access control
• 🌐 Microservices Architecture: Modular design, includes authentication, authorization, gateway, resource service, supports independent deployment and horizontal scaling
• ⚡ High-Performance Gateway: Based on Spring Cloud Gateway for routing, rate limiting, circuit breaking, and authentication
• 🧩 Cloud-Native Support: Compatible with Nacos, Sentinel, Seata, supports service discovery, configuration center, and distributed transactions
• 🎨 Modern Admin Dashboard: Built with shadcn-vue/ui

• 📚 Comprehensive Documentation: Covers architecture design, deployment guides, API docs, and secondary development instructions

🛠 Technology Stack

| Category | Technology | |-----------|-------------------------------------------------------------------| | Backend Framework | Spring Boot 3.5.5, Spring Cloud 2025.0.0, Spring Security, OAuth2 | | Microservice Governance | Nacos (Registry & Configuration Center), | | Gateway | Spring Cloud Gateway | | Database | MySQL 8 | | Frontend Framework | Vue 3 + Vite + TypeScript + shadcn/ui | | Build Tools | Maven, Docker, Docker Compose | | Monitoring | Spring Boot Actuator, Prometheus (optional), Grafana (optional) |

🏗 Project Structure

snail/
├── authentication/           # Authentication service (OAuth2 authorization server)
├── authorization/          # Authorization service (permission management, roles, menus)
├── gateway/               # API gateway (routing, authentication, rate limiting)
├── resource/              # Resource service (business API example)
├── snail-vue-app/          # Backend management interface (Vue3 + shadcn/ui)
└── pom.xml                      # Maven parent project