外部パートナーとのAPI連携時に気をつけるポイント - 10X Product Blog

はじめに こんにちは！yamakazu (@yamarkz) です。 近所の行きつけスーパーがサミットストアになったのですが、品揃えがとても良く、お店の雰囲気も明るくて、仕事終わりの買い物が最近の楽しみになってます 🥳 🛒🥗 さて今回は、開発方面のナレッジとして外部API連携の話を紹介します。非常にニッチな領域の話題ですが、わかる人にはわかるような内容です。 興味のある方はぜひ最後まで読んでみてください。 動機 新しく外部API連携の開発に着手するメンバーの助けになりたい、より良い外部API連携を実現したいという思いから、これまで開発を経験してきた中で理解した勘所を紹介します。 元々は社内向けに書き溜めておいたナレッジメモの内容ですが、特別社内に留めておく必要性もないので、せっかくならブログにしてしまおうと思い、ここで筆を取りました。 これは社内の同僚に向けた内容でありながら、似た境

[otihateten3510]

それができるならいいんだけどね、これお願いするの大分難易度高い気がする

[hitode909]

冪等性がないなら結果の参照APIが必要、というのが納得感があった（なくて困ることがたまにある…）

[verda]

この手のやつはSIerが死ぬほどやってるからIPAに情報纏まってそう

[remonoil]

実際には1→あとで反映しておきます＾＾、2→試験まで環境無し、3→現地確認、4→異様に煩雑、5→エラー想定無し、6→業務仕様は口伝、7→依頼ベースの参照、8→2回作成するとエラー、9→障害の考慮無し

[diveintounlimit]

ちゃんとした仕様書があって調整の効く相手のAPIとの連携って恵まれてるね…

[NOV1975]

残念ながら、openなapiであっても仕様書の正当性は怪しいよ（特に発生するエラーについての記述は

[merlotmk]

読むべし

[masawada]

わかり度が高い

[mizdra]

良い

[razokulover]

知見まとまっててよかった。

[otation]

パートナーAPI連携は本当に鬼門。できればやりたくない。事業部門はAPI開放してるしできるでしょ？ってスタンスでくるのがさらにキツい…

[jaguarsan]

ライブラリが余計なお世話や設定ミスしてることあるので、通信は必ず生のリクエスト/レスポンスを確認する。

[eos2323]

パートナーと言いつつ、製品並みのサポートになる

[sds-page]

当たり前のことが当たり前にできるようになりたい

[itotto]

この分類だと2,4,5が抑えられたら何とかなる気がしてる

[shifumin]

参照APIが用意されてなくて不具合発生時の原因調査がめちゃくちゃ大変だった時の記憶が呼び覚まされた

[papix]

最高

[diverdown03]

API仕様書作るときのメモ

[sugimomoto]

素晴らしい。検証環境用意してもらうのもほんと大事よね。あきらめて仕様書からMock APIをおこしたこともあるけれど、、、。