外部API連携のスタンスや技術面の考慮事項をまとめてみた

BRANK

はじめに株式会社tacomsでCTOやってる井上です！ 「連携先の会社が開発したAPI」 と定義します。外部APIには大きく分類すると、webhookのように送信してもらうパターンと、自分が送信するパターンの2つがあると思いますが、本記事では特に分類せずどちらも外部API連携と呼称します。連携開発する上でのスタンス🤝連携先のAPI仕様書は一緒に作り上げるもの外部APIは連携先の内部実装が分からないこともあり、API仕様書が唯一の指針となります。しかし、連携用のAPI仕様書を100%正確に作るのは難しいです。型自動生成などで実装していけばスキーマレベルでは正確なものになりますが、パラメータの説明やパラメータ同士の依存関係などは、どうしても人が書いていくことになるためミスがない状態にするのは難しいでしょう。上記背景から、双方が歩み寄りながらAPI仕様書作り上げるぞ！ ぐらいのスタンスが理想だなと思っています。API仕様書が間違ってますという指摘を繰り返すだけでなく、実際に検証環境のAPIを使ってAPI仕様書との差分を確認した上で、ドキュメントの修正提案など双方がFBを繰り返しながら、仕様書を作り上げていけると良いなと感じてます。連携パートナー…