技術ブログ

(技術系中心)基本自分用備忘録なので、あくまで参考程度でお願いします。

WEB APIを美しく設計する重要性

WEB APIを美しく設計する重要性

APIを設計する時によく言われる美しい設計とは一体何なのか?
また、何故美しい設計が必要なのかをまとめます。

美しい設計とは何か?

API設計で美しい設計とはわかりやすく整理されており、無駄がない完成度高いものをさします。 では、美しい設計でAPIを開発するメリットは何でしょうか?

メリットその1、使いやすい

綺麗な設計のAPIは単純に使いやすいです。
APIを公開すると、たくさんのユーザーが利用するケースが考えられますが美しい設計であればストレスフリーで使うことが出来ます。
逆に使いづらい、APIを公開するとユーザビリティが悪く評判が落ちる可能性があります。

メリットその2、後々変更しやすい

綺麗な設計のAPIはのちに変更箇所が出た時でも変更がしやすいです。
進化の早いIT業界では短い頻度でAPIを変化させなければなりません。美しい設計で書かれたAPIであれば、フレキシブルに設計を変更することが出来ます。

メリットその3、強固である

WEBAPIを公開すると、誰でもインターネットサービスを通じてアクセス可能になります。そうなってくると必ずセキュリティの問題が発生します。
こうした問題にもきちんと設計思想レベルで対応していればセキュリティリスクを下げることが出来ます。

メリットその4、恥ずかしくない

WEB APIを公開されると、多くの開発者がコードやインターフェイスを目にします。
開発者の目線でセンスの疑われるようなAPIを公開してしまうと、サービスの開発者のレベルが疑われてしまいます。
逆に美しい設計APIであれば自社のサービスのレベルの高さをアピールすることが出来ます。

まとめ

会社でAPI開発する時にはこの辺りのメリットを考えながら仕事してます。

参考書籍

Web API: The Good Parts