URL wrap

任意の URL に対してパスコードを設定し、URL Wrap 専用 URL を発行する。

Getting Started

Setting up database tables

データベースは MongoDB Atlas Database を使用します。

事前にプロジェクト、クラスター、データベースを作成し Connection string を取得する必要があります。

Examples:

  • Project Name: url-wrap
  • Cluster Name: UrlWrapDB-Cluster0
  • Database Name: url_wrap_db

Run the web application

cargo run

Development

Dependencies

  • MongoDB 4.x

Architecture

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