codemountains/mountix-shuttle

日本の山岳一覧・百名山API (Migrated to Shuttle)

日本の山岳一覧・百名山 API

Migrated to Shuttle

This project is a migration of codemountains/mountix to Shuttle.

Getting Started

Add Local secrets

Add Secrets.dev.toml to the root.

RUST_LOG = 'debug'

MY_API_KEY = 'the contents of my API key'

MOUNTAINS_URL = 'http://127.0.0.1:8080/api/v1/mountains'
DOCUMENTS_URL = 'https://github.com/codemountains/mountix-docs'
DEFAULT_DISTANCE = '5000'
MAX_DISTANCE = '100000'

Install Shuttle

cargo install cargo-shuttle

Run the web application

cargo shuttle run

Deploy to Shuttle

Add Secrets.toml to the root.

RUST_LOG = 'info'

MY_API_KEY = 'the contents of my API key'

MOUNTAINS_URL = 'http://127.0.0.1:8080/api/v1/mountains'
DOCUMENTS_URL = 'https://github.com/codemountains/mountix-docs'
DEFAULT_DISTANCE = '5000'
MAX_DISTANCE = '100000'

cargo shuttle project start
cargo shuttle deploy

Architecture

• mountix-driver (driver or controller)
  • ルーターとサーバーの起動を実装する
  • Axum の機能を利用してエンドポイントとサーバーの起動までを実装する
  • 内部的に行われた処理の結果、どのようなステータスコードを返すかをハンドリングしたり、JSON のシリアライズ・デシリアライズも担当する
• mountix-app (app or usecase)
  • ユースケースのレイヤーで、アプリケーションを動作させるために必要なロジックを記述する
  • 複数リポジトリをまたいでアプリケーションに必要なデータ構造を返すなどをおこなう
• mountix-kernel (kernel or domain)
  • ドメインのレイヤーで、アプリケーションのコアとなる実装を記述する
  • ドメインモデルの生成の記述などをおこなう
• mountix-adapter (adapter or infrastructure)
  • 外部サービスとの連携のレイヤー
  • RDS との接続やクエリの発行、MongoDB との接続や操作の実装を記述する

このリストの上側は上位レイヤー、下側は下位レイヤーになることです。 上位のレイヤーは下位のレイヤーを呼び出したり利用したりできますが、逆の呼び出しは許されません。 例えば、driver は app のモジュールを呼び出せますが、app は driver のモジュールを呼び出せません。

kernel と adapter の間にはDIP (Dependency Inversion Principle) が適用されます。例えば、kernel のリポジトリにはtraitの定義があるだけで、その実装は adapter にあります。

driver には Axum の定義程度しかありません。 Axum のRouter、ハンドラ、サーバの起動、Web アプリケーションの定義や設定に関することは、このレイヤーの中で定義する必要があります。

app はいわゆるユースケースのレイヤーです。このレイヤーはアプリケーションのプロセス全体を制御し、ロジックはこの範囲内で定義する必要があります。

kernel はいわゆるドメインのレイヤーです。このレイヤーはアプリケーションの中核となるコンテキストです。

adapter はインフラストラクチャに関係します。このレイヤーは外部のミドルウェアやサービス、APIに接続し、アクセスすることができます。 アクセスや接続の処理は、このレイヤーに定義されなければなりません。

License

This project is licensed under the MIT license.

mountix-shuttle's Issues

500 Internal Server Error in surroundings api

500 Internal Server Error

/api/v1/mountains/533/surroundings?distance=3000