endpoint

エンドポイント

endpoint

読み方:エンドポイント

endpointとは、ある機能やサービスにアクセスするための URL のことです。Web アプリケーションでは、クライアント(ブラウザ)とサーバーとの通信により、情報をやりとりします。この時にサーバー側のある機能やサービスにアクセスするためには、その機能やサービスに割り当てられたendpointを指定してアクセスします。

たとえば、Twitter の場合、ツイートを取得するためには次のようなエンドポイントがあります。

const endpoint = 'https://api.twitter.com/1.1/statuses/user_timeline.json'

このエンドポイントを使って、Twitter API にアクセスし、指定したユーザーのタイムラインを取得できます。

Next.js と TypeScript でのエンドポイントの使い方

Next.js では、API のエンドポイントを作成するために/pages/apiディレクトリを使用します。これにより、サーバーレス関数が作成され、HTTP リクエストを処理できます。

// /pages/api/hello.ts

import { NextApiRequest, NextApiResponse } from 'next'

export default function handler(req: NextApiRequest, res: NextApiResponse) {
  res.status(200).json({ text: 'Hello' })
}

このエンドポイントは、/api/helloとしてアクセス可能であり、レスポンスとして JSON を返します。

fetch('/api/hello')
  .then((response) => response.json())
  .then((data) => {
    console.log(data.text)
  })

このように、エンドポイントを使用することで、クライアントサイドからサーバーサイドの機能やサービスにアクセスすることができます。