APIハンズオンラーニング ―手を動かして学ぶAPIの設計と実装

2章API設計のパターン

この章は、APIのライフサイクルでの設計フェーズのための実践的なガイドである。APIの設計やセキュリティでのパターン、ベストプラクティスなどの一般的なトピックへの認識を高めることを目的としている。

ソフトウェアデザインパターンとは、ソフトウェアを作成する際によく発生する問題を解決するための指針である。APIの設計は多面的なプロセスであるが、APIスタイルの違いを超えて共通の課題も存在する。デザインパターンはこれらの課題を解決策の開発へと導く。

この章では、これらのパターンを選択して設計プロセスに組み込めるようになることを目標とする。レシピ集のような形式で、それぞれのパターンを個別に紹介する。これらのパターンの一部は、「5章　REST」でREST APIの例を実装する中で実際に適用されている。

2.1　API設計のパターンの例

どのようなAPIスタイルで作業するにしても、APIドキュメントで使われる自然言語、APIのバージョン管理の方法、インターフェースの命名規則、エンコード方式、データの提供方法などを明らかにしておく必要がある。この節では一般的なパターンを取り上げる。

API設計でのパターンをさらに学ぶには、JJ Geewax著『APIデザイン・パターン』（マイナビ出版）や以下の資料を推奨する。

• GoogleのAPI設計ガイド（https://google.aip.dev/1）
• MicrosoftのREST API設計ガイド（https://oreil.ly/q7A9o）
• REST APIの概要が紹介されている、REST API Tutorial（https://restfulapi.net）とLearn REST API Design（https://www.restapitutorial.com ...