README
¶
micro
Just a simple tool kit for building microservices.
Note: Please notice that this is just in experiment stage right now and API can be changed without notification, hence please don't use this for production.
What is micro?
micro is a Go tool kit for enterprise targeted for microservices or well designed monolith application. It doesn't aim to be a framework, but just a standard libraries for easily and quickly build API applications.
micro's vision is to be come a good tool kit for beginner/intermediate developers and hence it should be:
- Easy to use.
- Compatible with Go native libraries.
- Come with default ready to use features.
I expect micro requires no more than 15 minutes for a beginner/intermediate developer to be able to use the tool kit effectively. This means micro will come with lots of useful default features, but at the same time provide developers ability to provide their alternatives.
micro is now in the experiment stage and currently built around gRPC. It exposes both gRPC and REST API over 1 single port using grpc-gateway.
Currently, micro supports following components:
- Default, ready to use server:
- Exposes both gRPC and REST in 1 single port.
- Internal APIs: metrics, health checks
- Context logger with request-id
- Default, ready to use middleware:
- Logging
- Authentication
- Authorization
- Default, ready to use:
- Broker
- Configuration
- API document: Swagger
Why a new standard libraries?
micro is inspired by go-kit and go-micro.
go-kit is a good tool kit, but one of the thing I don't like go-kit is its over use of interface{} which cause a lot of unnecessary type conversions and some of other abstractions in the libraries which are not compatible with Go native libraries. Although go-kit is very flexible, it's a little bit hard to use for beginner/intermediate developers. It has a lot of options for developers to choose and hence hard to force everyone inside a company to use the same set of standards.
go-micro is a great framework for microservices and very well designed. And it influences micro very much, but there are some coding styles that I don't like go-micro, that's why I made micro for myself.
Documentation
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth defines standard interface for authentication.
|
Package auth defines standard interface for authentication. |
|
jwt
Package jwt implements authentication interfaces using JWT.
|
Package jwt implements authentication interfaces using JWT. |
|
Package broker defines standard interface for a message broker.
|
Package broker defines standard interface for a message broker. |
|
memory
Package memory provides a message broker using memory.
|
Package memory provides a message broker using memory. |
|
nats
Package nats provide a message broker using NATS.
|
Package nats provide a message broker using NATS. |
|
Package config defines standard interfaces for a config reader/writer.
|
Package config defines standard interfaces for a config reader/writer. |
|
envconfig
Package envconfig provides a convenient way to load config from environment variables into a struct using https://github.com/kelseyhightower/envconfig.
|
Package envconfig provides a convenient way to load config from environment variables into a struct using https://github.com/kelseyhightower/envconfig. |
|
examples
|
|
|
Package health defines standard interfaces and utilities for health checks.
|
Package health defines standard interfaces and utilities for health checks. |
|
Package log provides an easy-to-use and structured logger.
|
Package log provides an easy-to-use and structured logger. |
|
plugins
|
|
|
broker/nats
Module
|
|
|
cache/redis
Module
|
|
|
Package server provides a convenient way to start a new ready to use server with default HTTP API for readiness, liveness and Prometheus metrics.
|
Package server provides a convenient way to start a new ready to use server with default HTTP API for readiness, liveness and Prometheus metrics. |
|
util
|
|
|
fieldmaskutil
Package fieldmaskutil provides convenient utilities for working with field_mask.
|
Package fieldmaskutil provides convenient utilities for working with field_mask. |
|
mgoutil
Package mgoutil provides utilities for working with mgo library.
|
Package mgoutil provides utilities for working with mgo library. |
|
Package validator provides convenient utilities for validation using https://github.com/go-playground/validator.
|
Package validator provides convenient utilities for validation using https://github.com/go-playground/validator. |