yokai

妖怪

用於後端應用程式的簡單、模組化和可觀察的 Go 框架。

• 目標
• 文件
• 概述
  • 建築學
  • 基礎
  • 擴充
• 入門
• 陳列室
• 貢獻

目標

使用 Go 建立後端應用程式非常棒。

但要建立production-grade應用程序，您需要投入大量精力和樣板程式碼，從而引入甚至與應用程式邏輯無關的複雜性（例如依賴項連接、配置管理、可觀察性檢測等）。

為了解決這個問題，Yokai 的創建是為了實現以下目標：

• Simple ：它易於使用、配置和測試，使您能夠快速迭代並快速交付可維護的應用程式。
• Modular ：它可以使用可用的 Yokai 模組或您自己的模組進行擴展，以建立可進化的應用程式。
• Observable ：它帶有內建的日誌記錄、追蹤和指標工具，可以建立可靠的應用程式。

換句話說，Yokai 讓您專注於應用程式邏輯，同時處理其餘的事情。

文件

Yokai 的documentation位於 https://ankorstore.github.io/yokai。

概述

建築學

• Yokai core modules預先載入日誌記錄、追蹤、指標和運行狀況檢查工具，並公開私人 HTTP 伺服器以滿足基礎架構和偵錯需求。
• 可以新增 Yokai extensions modules來豐富您的應用程式功能，例如公共 HTTP / gRPC 伺服器、worker、ORM 等。
• 這些在 Yokai dependency injection system中可用，您可以依靠它來建立您的應用程式邏輯。

基礎

Yokai 是使用robust且well known Go 庫構建的，例如：

• HTTP 伺服器的 Echo
• gRPC-go 用於 gRPC 伺服器
• 用於設定管理的 Viper
• 用於可觀測性儀器的 OTEL
• 依賴注入系統的FX
• 等等。

擴充

Yokai 的extension system可讓您透過以下方式enrich您的應用程式功能：

• Yokai built-in模組
• Yokai 貢獻模組
• 你自己的模組

入門

Yokai 提供現成的application templates來啟動您的專案：

• 適用於 gRPC 應用程式
• 對於 HTTP 應用程式
• 對於工人應用程式

陳列室

Yokai 提供了一個展示室儲存庫，其中包含demo applications ，可以隨時運行，以查看其實際效果：

• gRPC 演示應用程式
• HTTP 演示應用程式
• 工人演示應用程式

貢獻

此儲存庫使用release-please來自動化Yokai的模組發布流程。

重要的

您必須提供原子提交和常規提交，因為發布過程依賴它們來確定要發布的版本並產生發行說明。