C#アプリケーション

Postman Cloneの構築: API呼び出しのためのクラスライブラリ設計

Tim Corey

47m 58s

APIは現代のアプリケーション開発の中心にあり、それらをテストし、相互作用するための適切なツールを持つことは重要です。ティム・コリーの動画"Class Library Design: Building a Postman Clone"は、デスクトップベースのPostmanクローンを順を追って構築する方法を案内します。

この記事では、ティム・コリーが動画で示した詳細なアプローチを取り入れて、Postmanクローンを構築する方法を探ります。ティムは、アプリケーション内のAPI呼び出しを駆動するクラスライブラリの作成をステップバイステップで案内します。最後には、Postmanクローンの動作するMVP（最小実行可能製品）バージョンを手にすることができます。

このプロセスは初心者にも親しみやすいものであり、自分自身のPostmanや類似のアプリケーションを作成することを考えている開発者にとって価値のある主要なプログラミング原則も示しています。プロセスをさらに深く探りましょう。

紹介とセットアップ

ティムはこのレッスンの目的を次のように説明します：アプリケーション内でAPIコールを機能させるためのビジネスロジックとデータアクセスレイヤーを作成すること。これはMVPであり、後で拡張可能な機能的なバージョンであることを強調します。

コードに入る前に、ティムはこのコースがポートフォリオに適しているように設計されていると指摘しつつ、プロジェクトを直接コピーすることについては注意を呼びかけます。代わりに、開発者がC#、APIインタラクション、UIデザインのスキルを示すために独自のプロジェクトを作成するインスピレーションとして使用することを奨励します。

APIアクセスクラスの作成

ティムはクラスライブラリを開き、クリーンな状態から始める方法を説明します。デフォルトのClass1を削除し、新しいクラスをAPIAccessという名前で作成します。これはすべてのAPIインタラクションを処理します。

彼のメソッド設計のアプローチを説明し、パブリックvoidメソッドから始め、string urlのようなパラメータを追加し、実際のAPIリクエストを処理できる非同期タスクに徐々に洗練させると説明します。

public class APIAccess
{
    private readonly HttpClient client = new();
    
    public async Task&lt;string&gt; CallApiAsync(string url)
    {
        var response = await client.GetAsync(url);
        if (response.IsSuccessStatusCode)
        {
            return await response.Content.ReadAsStringAsync();
        }
        return $"error: {response.StatusCode}";
    }
}

public class APIAccess
{
    private readonly HttpClient client = new();
    
    public async Task&lt;string&gt; CallApiAsync(string url)
    {
        var response = await client.GetAsync(url);
        if (response.IsSuccessStatusCode)
        {
            return await response.Content.ReadAsStringAsync();
        }
        return $"error: {response.StatusCode}";
    }
}

Text

ティムはパフォーマンス向上のため、HTTPクライアントインスタンスを1つだけ作成し、各コールで再初期化しないように強調します。

APIレスポンスの処理

HTTPクライアントが設定された後、ティムはAPIコールからのレスポンスを取得する方法を示します。非同期voidではなくTask<string>を返すことが重要であると指摘し、イベントハンドラを除いてです。

デモのために、JSONプレイスホルダーからのサンプルAPIを使用し、投稿、コメント、やることリストなどのフェイクデータを提供します。 API URLをUIフォームHTMLに貼り付け、結果のTextフィールドを使用してレスポンスHTMLまたはJSONを表示します。

results.Text = await api.CallApiAsync(apiText.Text);

results.Text = await api.CallApiAsync(apiText.Text);

Text

ティムは生のJSON出力がコンピューターには読みやすいがユーザーには親しみにくいとして、次のステップであるJSONのフォーマットを導入します。

JSON出力のフォーマット

ティムはJsonSerializerを使用してレスポンスJSONを読みやすくする方法を示します：

var jsonElement = JsonSerializer.Deserialize&lt;JsonElement&gt;(responseJson);
var prettyJson = JsonSerializer.Serialize(jsonElement, new JsonSerializerOptions { WriteIndented = true });

var jsonElement = JsonSerializer.Deserialize&lt;JsonElement&gt;(responseJson);
var prettyJson = JsonSerializer.Serialize(jsonElement, new JsonSerializerOptions { WriteIndented = true });

Text

これにより、開発者はUIに読みやすいJSONを表示でき、JSONテキストエディタでの使用やエンドポイントのテスト時に便利です。また、ティムは生の出力とフォーマットされた出力の切り替えオプションを追加し、UIでデータを表示するかプログラムで処理するかに応じて柔軟性を提供します。

将来の拡張の計画

MVPはGETリクエストのみをサポートしているが、POST、PATCH、PUT、DELETEなどの他のHTTPアクションに対する計画方法を示します。 HTTPActionという名前のenumを作成し、デフォルト値をGETに設定し、既存のメソッドを再コーディングすることなくスケールできるようにコードを準備します。

public enum HTTPAction
{
    GET
}

public enum HTTPAction
{
    GET
}

Text

この先見の明のある設計は、メンテナンス可能で拡張しやすいPostmanクローンを作成したい開発者にとって良い練習です。

URLの検証

ティムは、有効なHTTPSエンドポイントのみをユーザーが提供することを確認するためにURL検証メソッドを紹介します：

public bool IsValidURL(string url)
{
    if (string.IsNullOrWhiteSpace(url)) return false;
    return Uri.TryCreate(url, UriKind.Absolute, out Uri uriResult) && uriResult.Scheme == Uri.UriSchemeHttps;
}

public bool IsValidURL(string url)
{
    if (string.IsNullOrWhiteSpace(url)) return false;
    return Uri.TryCreate(url, UriKind.Absolute, out Uri uriResult) && uriResult.Scheme == Uri.UriSchemeHttps;
}

Text

ユーザー入力を信頼せず、必要な場合は複数回検証することの重要性を説明します。これにより、無効なURLによるアプリケーションの破損を防ぎ、エラーメッセージがワークフローを中断するのを防ぎます。

APIアクセスとUIの統合

検証が整ったら、APIアクセスをダッシュボードUIと統合する方法を示します：

APIAccessクラスのインスタンスを生成します。
URLを検証します。
結果テキストエディタにレスポンスJSONを表示します。
無効または失敗したリクエストに対する意味のあるエラーメッセージを表示します。

if (!api.IsValidURL(apiText.Text))
{
    systemStatus.Text = "無効なURL";
    results.Text = string.Empty;
    return;
}
results.Text = await api.CallApiAsync(apiText.Text);

if (!api.IsValidURL(apiText.Text))
{
    systemStatus.Text = "無効なURL";
    results.Text = string.Empty;
    return;
}
results.Text = await api.CallApiAsync(apiText.Text);

Text

ティムはクリーンなUIデザインの重要性を強調し、各リクエストを空の結果領域から始め、成功または失敗に基づいてシステムステータスを更新します。

依存性注入と単体テストのためのインタフェースの使用

ティムはIAPIAccess、APIアクセス用のインタフェースを紹介します。これは単体テストとコードを依存性注入に備えるためのベストプラクティスです：

public interface IAPIAccess
{
    Task&lt;string&gt; CallApiAsync(string url);
    bool IsValidURL(string url);
}

public interface IAPIAccess
{
    Task&lt;string&gt; CallApiAsync(string url);
    bool IsValidURL(string url);
}

Text

具象クラスの代わりにインタフェースに対してコーディングすることで、テスト用に実装を交換したり、APIロジックをUIや他の依存コードを変更せずにアップグレードすることができます。このMVPにはややオーバーキルですが、将来のアプリケーションの改善にとっては価値があります。

アプリケーションのテストと実行

すべてのパーツが整ったところで、ティムはWindowsでアプリケーションを実行し、JSONプレイスホルダーURLを貼り付け、フォーマットされたJSONレスポンスを正しく表示します。無効なURLが適切に拒否され、ユーザー入力エラーであってもアプリが安定していることを確認する方法を示します。

これにより、GETリクエストを行い、入力を検証し、ユーザーフレンドリーな形式でレスポンスを表示できる機能的なPostmanクローンが形成されます。

次のステップ：ポートフォリオとGitHub統合

ティムはこのプロジェクトをポートフォリオ対応のアイテムに変える重要性を強調してレッスンを終了します。彼は以下を提案します：

プロジェクト用のGitHubリポジトリを作成すること。
アプリケーションの説明が明確なREADMEを追加すること。
他の人がテストできるダウンロード可能な実行ファイルを含めること。
UIと機能をスクリーンショットやGIFで強調すること。
プロセス、セットアップ、コード構造を文書化すること。

彼のコードを単にコピーして自分のものとしてアップロードすることを避けるように警告します。代わりに、開発者はこれらの教訓を利用して、個人のスタイルやスキルセットを反映したPostmanクローンや類似のアプリを作成する必要があります。

このアプローチに従うことで、開発者はコードの熟練度を示すだけでなく、ソフトウェアプロジェクトを探求し、更新し、維持する能力を示し、潜在的な雇用主にとって価値があります。

結論

Tim Coreyのビデオは、Postmanクローンをゼロから構築するための包括的なガイドを提供します。クラスライブラリのセットアップからAPIコールの処理、JSONレスポンスのフォーマット、入力の検証、インタフェースと依存性注入で将来の強化のためにプロジェクトを準備するまで、このレッスンはアプリケーション開発プロセス全体をカバーします。

このアプローチに従うことで、開発者はプレーンC#を使用したMVP Postmanクローンを作成し、レスポンスHTMLやJSONを表示するためのUI要素を統合し、ポートフォリオでの披露に向けたGitHubプロジェクトを準備できます。このステップバイステップの方法論はコードだけでなく、計画、プロセス、デザイン思考を強調し、プロのソフトウェア開発者にとって重要なスキルです。