Yokai

Yokai

バックエンドアプリケーション向けの、シンプルでモジュール式、かつオブザーバビリティを備えた Go フレームワークです。

• 目標
• ドキュメント
• 概要
  • アーキテクチャ
  • 基盤
  • 拡張機能
• はじめに
• ショールーム
• コントリビューション

目標

Go でバックエンドアプリケーションを構築するのは素晴らしいことです。

しかし、production-grade なアプリケーションを構築するには、アプリケーションのロジックとは無関係な複雑さ（依存関係の配線、設定管理、オブザーバビリティの計測など）を持ち込む、多くの作業やボイラープレートコードが必要になります。

これを解決するため、Yokai は以下の目標を念頭に置いて作られました。

• Simple：使いやすく、設定やテストも簡単なため、素早く反復し、保守しやすいアプリケーションを迅速に提供できます。
• Modular：利用可能な Yokai モジュールや独自のモジュールで拡張でき、進化し続けるアプリケーションを構築できます。
• Observable：ロギング、トレーシング、メトリクスの計測機能が組み込まれており、信頼性の高いアプリケーションを構築できます。

つまり、Yokai がその他のことを担う一方で、アプリケーションのロジックに集中できます。

ドキュメント

Yokai のドキュメントは https://ankorstore.github.io/yokai でご覧いただけます。

概要

アーキテクチャ

• Yokai のコアモジュールは、ロギング、トレーシング、メトリクス、ヘルスチェックの計測機能を事前に読み込み、インフラストラクチャやデバッグの用途にプライベート HTTP サーバーを公開します。
• Yokai の拡張モジュールを追加して、パブリック HTTP／gRPC サーバー、ワーカー、ORM などのアプリケーション機能を強化できます。contrib モジュールや独自のモジュールも追加できます。
• これらは Yokai の依存性注入システムで利用でき、このシステムを活用してアプリケーションのロジックを構築できます。

基盤

Yokai は、以下のような堅牢で広く知られた Go ライブラリを使用して構築されています。

• HTTP サーバー向けの Echo
• gRPC サーバー向けの gRPC-go
• 設定管理向けの Viper
• オブザーバビリティの計測向けの OTEL
• 依存性注入システム向けの Fx
• その他多数。

拡張機能

Yokai の拡張システムを利用すると、以下によってアプリケーション機能を強化できます。

• Yokai の組み込みモジュール
• Yokai の contrib モジュール
• 独自のモジュール

はじめに

Yokai は、プロジェクトを始めるためにすぐ使えるアプリケーションテンプレートを提供しています。

• gRPC アプリケーション向け
• HTTP アプリケーション向け
• MCP アプリケーション向け
• ワーカーアプリケーション向け

ショールーム

Yokai では、動作を確認できる、すぐに実行可能なデモアプリケーションを含むショールームリポジトリを提供しています。

• gRPC デモアプリケーション
• HTTP デモアプリケーション
• MCP デモアプリケーション
• ワーカーデモアプリケーション

コントリビューション

このリポジトリでは、Yokai のモジュールのリリースプロセスを自動化するために、release-pleaseを使用しています。

重要

リリースプロセスでは、リリースするバージョンの決定とリリースノートの生成にコミットを使用するため、アトミックかつ規約に準拠したコミットを作成する必要があります。