miso

miso

main branch is unstable, install miso with tags instead

miso, yet another simple application framework.

Initially, it was a fun project for me to prove: 'yes, we can just write a framework ourselves.'. Surprisingly, it does work very well.

miso provides an opinionated way to write applications (mainly backend web services). It's convenient enough with reasonable code complexity. Do not expect it to be a full-fledged framework, it's surely not.

The overall target is to make it as small and simple as possible, backward compatibility may break in future releases.

Include miso in your project

Install a specific release of miso:

go get github.com/curtisnewbie/miso@v0.4.13

Again, miso is an opinionated framework, it might not be suitable for mature codebase, but you are free to explore this framework in a new project.

You can generate a new project using misogen (see CLI Tools).

Documentations

• CLI Tools
• Configuration
• Application Lifecycle
• HTTP Client
• HTTP API Declaration
• Tracing
• Database
• Cron Scheduler & Distributed Task Scheduling
• Validation
• Service Healthcheck
• Rabbitmq and Event Bus
• Kafka
• API Documentation Generation
• Debugging Performance: pprof, trace and gops
• List of Supported Middlewares
• Upgrade & Migration

Projects that use miso

The following are projects that use miso (mine tho), see also moon-monorepo.

• gatekeeper
• event-pump
• mini-fstore
• vfm
• user-vault
• hammer
• goauth
• logbot
• doc-indexer

Updates

[!IMPORTANT]

See Upgrade & Migration for automatic migration.

• Since v0.2.0, 21 configuration properties are renamed, these property names are not backward compatible. If you are using deprecated configuration names, error log are printed as a warning.
• Since v0.3.0, a bunch of breaking changes are introduced, e.g., refactoring package structure, removing deprecated code and so on. Lots of methods and types are moved from util pkg to pkgs such as cli, csv, errs, expr, flags, hash, heap, pair, queue, rfutil, slutil, stack, and strutil.
• Since v0.3.5, a few funcs in errs pkg are deprecated.
• Since v0.3.6, file (os) related funcs in pkg util are deprecated and moved to util/osutil; and FindTestdata(..) func in pkg util is deprecated and moved to util/testutil.
• Since v0.3.7, async code in pkg util is deprecated and moved to util/async, while previous code may continue to work, it will be deleted in later release.
• Since v0.4.0,
  • The default lowercase camel case json field naming strategy has been removed. Package encoding/json is moved to util/json.
  • A lot of deprecated code is removed. All code directly under util pkg is moved to dedicated pkgs, e.g., util/strutil, util/snowflake, util/randutil, util/iputil, util/pool, util/profile, util/constraint, util/atom, util/must, util/cmputil and more.
  • There are a lot of breaking changes, make sure you follow the guide and use the automatic migration tool.
• Since v0.4.9, pkg util/errs was renamed to errs pkg.
• Since v0.4.10, pkg util/lua was moved to middleware/lua pkg, and pkg util/expr was moved to middleware/expr pkg.
• Since v0.4.11, pkg middleware/user-vault/common was refactored to flow pkg.

[!WARNING]

Since Jsoniter is nolonger actively maintained, last commit was 3 years ago. Jsoniter will be removed from this repository in later release. The default json processing behaviour has been removed. Previously, all struct fields are by default serialized/deserialized using lowercase camel case style without needing to add any json tag. Since v0.4.0, json tags must be added manually to maintain compatibility.