Fdic Bank Find MCP Server

🚀 FDIC銀行データAPIプロジェクトドキュメント

このプロジェクトは、FDIC銀行データ用の最新のAPIを提供しています。YAML定義ファイルを自動的に処理するコード生成、パラメータ検証、動的なレスポンスフィールドなど、様々な機能をサポートしています。コードはRustで記述され、AIツール（Windsurf EditorやGPT - 4.1など）を活用して開発されています。

✨ 主な機能

1. YAMLコードの自動生成

このプロジェクトは、FDICが提供するYAML定義ファイルを解析し、それに対応するRustコードを自動生成します。これにより、APIの拡張性と保守性が大幅に向上します。

2. パラメータ検証とデータ処理

パラメータ検証ロジックを実装し、リクエストの有効性を確保します。また、返されるデータをOpenAPI規格に合わせてフォーマットします。

3. 動的なレスポンスフィールドのサポート

/institutionsなどの一部のインターフェースは、クエリ結果に応じて追加のフィールド（ハイライトやスコアなど）を返します。これらのフィールドは、基盤となる検索エンジン（Elasticsearchなど）から直接取得されます。

📦 インストール

このセクションでは、原READMEにインストール手順が記載されていないため、省略されています。

💻 使用例

基本的な使用法

// 示例：解析YAML文件并生成处理代码
fn generate_handler(yaml_path: &str) -> Result<String, Box<dyn Error>> {
    let yaml = std::fs::read_to_string(yaml_path)?;
    let spec: Spec = serde_yaml::from_str(&yaml)?;
    // 根据spec生成相应代码
    Ok(format!("pub fn handler(req: Request) -> Response {{\n  // 处理逻辑\n}}"))
}

高度な使用法

// 示例：自动生成路由注册代码
#[automatically_registered]
mod handlers {
    use super::*;

    #[get("/institutions")]
    pub fn get_institutions() -> Response {
        // 处理逻辑
    }
}

📚 ドキュメント

開発フロー

1. 定義ファイルの解析

このプロジェクトは、FDICが提供するYAML定義ファイルを自動的に解析し、対応するRustコードを生成します。具体的な手順は上記のコード例を参照してください。

2. インターフェースの自動登録

生成された処理関数は、自動的にルートに登録されます。src/handlers/mod.rsを手動で維持する必要はありません。

貢献ガイド

1. 問題と機能要求の提出

リポジトリ内のISSUE_TEMPLATEテンプレートを使用して、問題や機能要求を提出してください。

2. コード貢献の作成

• ブランチ名はfeature/<issue_id>の規則に従ってください。
• PRを提出する前に、全面的なテストを実行し、関係のないコミットを整理してください。

3. コードスタイルガイドの遵守

コードはRustのフォーマット規範に従い、高い可読性を維持し、CI/CDパイプラインのチェックを通過する必要があります。

ガバナンスとドキュメント

規範ファイル

• CONTRIBUTING.md：貢献ガイド
• CODE_OF_CONDUCT.md：行動規範
• SECURITY.md：セキュリティ規範
• LICENSE：プロジェクトのライセンス

オープンリソース

すべてのオープンリソースは、プロジェクトのGitHubリポジトリにホストされています。コミュニティの皆様の維持にご協力いただけると幸いです。

動的なレスポンスフィールドに関する説明

レスポンスの例

{
  "type": "success",
  "data": [
    {
      "data": { "NAME": "Wells Fargo Bank", ... },
      "highlight": { "NAME.raw": ["<em>Wells</em> ..."] },
      "score": 1091.385
    }
  ],
  "meta": { ... }
}

クライアントの注意事項

• dataオブジェクトは常に返されますが、highlightとscoreフィールドはオプションです。
• これらのフィールドは、クライアントやプロキシが結果を解釈して並べ替えるのに役立ちます。

🔚 まとめ

このプロジェクトは、最新のプログラミング言語とAIツールを組み合わせて、効率的で信頼性の高いAPIサービスを構築する方法を示しています。コミュニティの開発者の皆様に、積極的な参加をお待ちしています。