📝

APIをチームメイトと考える

2022/10/10に公開約800字

はじめに

APIをチームメイトと考える。
その意識ひとつでAPIの設計が "ほんの少し" 良くなるのではないか、ひいては良いサービスが作れるのではないか、ふとそう思ったので記事にしてみます。

今のご時世、チームメイトとAPI、どちらとのコミュニケーションが多いか

昨今、リモートワークを採用している企業さんも多く、例えば同じプロジェクトのバックエンドエンジニアチームでも、コミュニケーションは週に数回のチャットのみ、ということも多いのではないでしょうか?

対して、自分が作っている(あるいはフロントエンドチームの場合、自分が使っている)APIとコミュニケーションする機会はいかがでしょうか?もしかしたらチームメイトとのコミュニケーションよりも回数が多い、さらにはより重要なコミュニケーションなのではないでしょうか?

ふとそう考えたとき、APIとの向き合い方が変わった

あくまで私の一例ですが。
APIがチームメイトよりコミュニケーションが重要な相棒という考え方をしてみると、なぜかAPI設計に対する考え方が少し変わりました。
これまでも適当にAPIを設計していたわけではないので、最終的に出来上がるAPI設計は同じものだとしても、取り組む姿勢が変わった気がします。

なんなら人間のチームメイトよりも長く付き合うことになるAPI、適当に設計するわけにはいけません。これから長い間をともにする(そして重要な関係を保つべき)チームメイトなのです。

たったこれだけの意識改革だけで、

  • API名の決め方
  • APIの役割の決め方

を "愛着持って"設計するような考え方になりました。技術不足による設計不備はあるとしても、少なくとも "愛着持って"取り組んだ作業が、そうでない場合の作業より劣ることは無いと考えているので、たった一つの意識改革だけで良い事づくめが気がしています。

さいごに

まぁただのポエムですが、それでも役立つ人には役立つ考え方なんじゃないかなと思って記事にしてみました。色々意見いただきたい内容ですm

Discussion

ログインするとコメントできます