README
¶
Sphere
Sphere is a Protobuf-first Go service framework for definition-driven development. Define once, generate rapidly, and scale seamlessly from monolithic architecture to microservices.
Core Components
Protoc Code Generation Plugins
protoc-gen-sphere- Define HTTP services using proto3 and automatically generate Go server codeprotoc-gen-route- Generate routing code for generic serversprotoc-gen-sphere-errors- Define error types in proto3 and automatically generate error handling codeprotoc-gen-sphere-binding- Generate custom binding tags for Go structs (overcome proto3 limitations)
HTTP Framework
httpx- Unified HTTP framework abstraction supporting popular Go HTTP frameworks (Gin, Fiber, Echo, Hertz, etc.)
Tools and Libraries
sphere-cli- Project generation and management toolconfstore- Configuration management libraryentc-extensions- Ent ORM enhancement tools
Project Templates
sphere-layout- Default template with Ent as ORMsphere-simple-layout- Simplified versionsphere-bun-layout- Template with Bun as ORM
Documentation
For complete documentation, visit go-sphere.github.io
License
MIT License. See LICENSE for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
core
|
|
|
infra
|
|
|
server
|
|
|
social
|
|
|
utils
|
|
|
contextutil/metadata
Package metadata provides utilities for attaching and retrieving metadata from Go contexts.
|
Package metadata provides utilities for attaching and retrieving metadata from Go contexts. |
|
encoding/baseconv
Package baseconv provides customizable base encoding/decoding functionality for arbitrary alphabets.
|
Package baseconv provides customizable base encoding/decoding functionality for arbitrary alphabets. |
|
encoding/numconv
Package numconv provides utilities for converting 64-bit integers to/from base32 and base62 encodings.
|
Package numconv provides utilities for converting 64-bit integers to/from base32 and base62 encodings. |
|
exp/captcha
Package captcha provides a complete verification code management system with rate limiting.
|
Package captcha provides a complete verification code management system with rate limiting. |
|
idgenerator
Package idgenerator provides distributed unique ID generation using the Snowflake algorithm.
|
Package idgenerator provides distributed unique ID generation using the Snowflake algorithm. |
|
secure
Package secure provides security-related utilities including password hashing, string censoring, and random string generation for tokens and passwords.
|
Package secure provides security-related utilities including password hashing, string censoring, and random string generation for tokens and passwords. |
Click to show internal directories.
Click to hide internal directories.