先生と生徒の会話形式で理解しよう

生徒

「C#を使って自分専用のAPIサーバーを作ってみたいのですが、何から始めればいいのでしょうか？」

先生

「APIサーバーを作るには、ASP.NET Coreという技術を使うのが一番の近道ですよ。まずは基本的な仕組みから理解していきましょう。」

生徒

「難しそうですが、初心者でも動くものが作れますか？」

先生

「大丈夫です。料理に例えると、APIは注文を受けて料理を提供するレストランのカウンターのようなものです。その仕組みを丁寧に解説しますね。」

1. REST APIとASP.NETの基礎知識

まず、REST API（レストエーピーアイ）について解説します。これは、インターネット上で異なるプログラム同士が情報をやり取りするためのルールのことです。例えば、あなたがスマホアプリで天気予報を見るとき、アプリは天気情報を配信するサーバーに「今の天気を教えて」とリクエスト（要求）を送り、サーバーが「晴れです」というレスポンス（応答）を返します。このやり取りの仕組みがREST APIです。

次に、ASP.NET（エーエスピーネット）についてです。これはマイクロソフトが提供している、WebサイトやAPIサーバーを効率的に開発するための強力な枠組み（フレームワーク）のことです。C#というプログラミング言語を使って、インターネット通信の複雑な処理を簡単に書くことができます。プログラミング未経験の方でも、このフレームワークを使うことで、本格的なWebサービスの土台を手に入れることができます。

2. APIサーバーを作るための環境準備

APIサーバーを構築するには、まずパソコンに開発道具を揃える必要があります。具体的には、Visual Studio（ビジュアルスタジオ）という開発ソフトをインストールします。これはプログラムを書くための専用のワープロソフトのようなものです。

インストールする際は、ASP.NETとWeb開発のワークロードを選択してください。これによって、C#でAPIを作るための機能が自動的に整います。環境が整うと、プロジェクトと呼ばれるプログラムの保存場所を作成できるようになります。プロジェクトは、一つのアプリケーションを構成するファイル群をまとめた入れ物だと考えてください。まずは空のプロジェクトを作成して、動作確認ができる状態まで持っていくことが最初の目標となります。

3. 最初の一歩！最小限のAPIを作ってみよう

それでは、実際にコードを書いてみましょう。ASP.NETでは、コントローラーと呼ばれるクラスを使って、外部からの要求を受け取ります。コントローラーとは、レストランの注文係のように「誰からどんな注文が来たか」を判断して、適切な料理（データ）を返す役割を担う部分です。

以下のコードは、ブラウザからアクセスすると「Hello World」と返してくれる最もシンプルなAPIの例です。


[ApiController]
[Route("[controller]")]
public class HelloController : ControllerBase
{
    [HttpGet]
    public string Get()
    {
        return "Hello World!";
    }
}

ここで登場した[HttpGet]は、情報を受け取るための命令です。WebブラウザでURLを入力して開く動作は、専門用語でGETリクエストと呼ばれます。このコードがあることで、サーバーは「情報が欲しい」という注文を受け付けることができるようになります。

4. 通信の仕組みを理解する：GETとPOSTの違い

API通信には、目的によって異なる呼び出し方があります。初心者の方がまず覚えるべきは、GETとPOST（ポスト）という2つの手法です。

GETは、先ほど説明したように「情報を取得する」ときに使います。Webサイトを閲覧するのもこのGETの仕組みです。一方、POSTは「新しい情報をサーバーに送って登録する」ときに使います。例えば、SNSで新しい投稿を作成したり、ユーザー登録で名前を送ったりするときは、このPOSTを使います。


[HttpPost]
public string CreateData([FromBody] string data)
{
    return "受け取ったデータ: " + data;
}

[FromBody]は、送られてきたデータの中身を取り出すための命令です。POSTを使うと、URLには見えない形で、パスワードや文章などの大きなデータを安全にサーバーへ送ることが可能になります。

5. データをJSON形式で返す方法

APIでやり取りするデータは、JSON（ジェイソン）という形式が一般的です。JSONは、人間にも読みやすく、機械でも処理しやすいデータ形式で、例えば{"name": "田中", "age": 25}のような書き方をします。ASP.NETは非常に賢いので、C#で作成したクラスのデータを勝手にこのJSON形式に変換して返してくれます。


public class User
{
    public string Name { get; set; }
    public int Age { get; set; }
}

[HttpGet("user")]
public User GetUser()
{
    return new User { Name = "山田", Age = 30 };
}

このコードを実行すると、ブラウザ上には{"name": "山田", "age": 30}という形式でデータが表示されます。これがAPI通信の基本であり、スマホアプリやWebフロントエンドとサーバーが連携するための橋渡しとなります。

6. サーバーを動かしてテストする手順

プログラムが書けたら、実際にサーバーを起動させて動作を確認しましょう。Visual Studioの実行ボタン（三角のアイコン）を押すと、自動的にWebサーバーが起動します。このとき、ブラウザが立ち上がり、localhostという自分自身のパソコン内にあるサーバーのアドレスにアクセスします。

最初は画面に何も表示されないかもしれませんが、URLの末尾に設定したルート名（コントローラー名）を入力することで、自分が書いたプログラムの結果が表示されます。もしエラーが出る場合は、スペルミスがないか、プロジェクトの設定が正しいかを確認しましょう。プログラミングの学習において、エラーは「間違いを教えてくれる先生」です。何度も挑戦して、一つずつ解決していくことで、確実に力がついていきます。これであなたもAPI開発者の第一歩を踏み出しました。