API

異なるアプリケーションが互いに通信できるアプリケーションプログラミングインターフェース

定義

API(アプリケーションプログラミングインターフェイス)は、アプリケーション同士がコミュニケーションをとるための言語です。onRuntimeでは、プロジェクトの異なる部分をつなげるために常に使用しています。APIをレストランのウェイターのように考えてみてください。注文を置く(リクエスト)と、頼んだものを持ってきてくれます(レスポンス)。キッチンで何が起こっているかを知る必要はありません。

我々がAPIを愛する理由

  • すべてを一緒に機能させる:異なるシステムがデータを簡単に交換できる
  • モジュラーにしてくれる:独立したコンポーネントを開発して簡単に接続できる
  • データを守ってくれる:誰が何にアクセスできるかを正確にコントロールできる
  • 時間を節約してくれる:全体を再構築することなく、1つの部分を更新できる

我々が日常的に使用するAPI

RESTful API

我々の日常の必需品!ほとんどのウェブプロジェクトで使用しています。シンプルで、ステートレス(リクエストごとに記憶を持たない)で、クラシックなHTTPメソッドを使用します。Tonight Passのようなデカップルされたインターフェースに最適です。

GraphQL API

特定の複雑なプロジェクトではこれらが大好きです!15の異なるエンドポイントを作成する代わりに、クライアントが必要なデータを正確にリクエストできるようにします。Kitchnでは、これにより大幅な帯域幅を節約できました。

SOAP API

正直に言うと、もうあまり使っていません... XMLと超厳格な仕様が少し古臭いです。でも、エンタープライズプロジェクトでは時々遭遇します。

我々が日常的に使う方法

onRuntimeでは、APIはテクノロジースタックの中心です。次のことが可能になります:

  • デカップルされたアプリケーションを構築する(フロントエンド/バックエンドを分ける)
  • 第三者サービスを簡単に統合する(支払い、マッピングなど)
  • 特定のプロジェクトでマイクロサービスアーキテクチャを開発する

APIを設計するときは、必ず最初にSwaggerやPostmanでドキュメント化します。考えを整理するのに役立ち、チームのためのしっかりとしたリファレンスになります。信じてください、無駄な会議をかなり減らしてくれますよ!