まず第一に、この API が本当に必要な理由を決定します。この API 自体を使用するクライアント アプリを作成する場合、それは正当な理由です。あなたのサービスがうまくいけば人気が出たら、誰かがその API を使って面白いことをしてくれることを期待しているだけなら、それは悪い理由です。誰も使いたがらないのに、API の作業に長い時間を費やすことになります。サービスの人気を高め、最初に API への関心を測ります。
とは言っても、API は、構造化された機械可読な XML または JSON (または別の形式) でデータを提供するサイト上の別の URL に過ぎず、通常のページに提供される HTML ドキュメントと根本的に異なるものではありません。主な違いは、API が適切に設計され、安定し
ている必要があることです。HTML は気まぐれでいつでも再設計できますが、クライアントが API を使用するように記述されると、それはしばらくの間変更されるべきではありません。そのため、API の使用方法とデータ形式を十分に計画する必要があります。これは、何に使用するかをよく知っていれば簡単です。他の大規模サービスの既存の API を詳細に調べて、詳細の一部をどのように解決したかを確認してください。
内部的には、アプリケーションをモジュール化して構築する必要があります。たとえば、MVC パターンを使用して、懸念事項を適切に分離します。モデルにコア ロジックがあり、2 つ(またはそれ以上) のビューがあります。1 つの通常の HTML ビューと、ほとんど同じデータに対する JSON/XML API ビューです。つまり、API ビューで複製しなければならない重要なロジックを HTML と混ぜないでください。