[B! API] greenbowのブックマーク

RESTful のウェブ API 設計で避けるべき 6 つのよくあるミス | Google Cloud 公式ブログ

※この投稿は米国時間 2022 年 12 月 1 日に、Google Cloud blog に投稿されたものの抄訳です。オンラインで、組み立て式のテーブルを注文したとします。ところが、パッケージを開けてみると、組立説明書が入っていません。完成品がどんなものかはわかっていても、それぞれのパーツをどう組み立てればいいのか、まるでわかりません。設計が不十分な API を使うコンシューマ開発者も、同じような経験をしているといえます。適切に設計された API なら、容易に見つけ、検索してアクセスし、使用することができます。高品質の API は、コンシューマ開発者がアイデアをひらめき、新しいユースケースを作り上げる手助けになってさえくれます。もちろん、API 設計を改善する方法はあります。たとえば、RESTful のプラクティスに従うなどです。しかし、お客様が知らず知らずのうちに、ちょっとした不便

greenbow 2022/12/16

リンク

Nintendo SwitchコントローラーにWebアクセス、なぜ可能なのか

みなさんはNintendo Switchを持っているだろうか。そのSwitchのコントローラーであるJoy-ConにWebブラウザーからアクセスできることをご存じだろうか。つまりJoy-Conを入力デバイスとしたゲームなどをWebアプリとして作れるということだ。今回はWebブラウザーがJoy-Conにアクセスできる仕組みについて紹介しよう。 WebHID APIの概要 WebブラウザーがJoy-Conにアクセスできるのは、WebHID APIがブラウザーにサポートされたからだ。WebHID APIとは、名前の通り、HID（Human Interface Device）にアクセスするためのAPIで、JavaScriptのコードを通して利用できる。誰にとってもなじみがあるHIDを具体的に挙げるとしたら、マウスやキーボードだろう。WindowsやmacOSなどのOSで世の中のマウスやキーボード

greenbow 2022/05/13

リンク

日本の祝日APIをリリースしました - ケンオールブログ

アップデートのお知らせ(2022/03/15) 2022/03/15(火)にケンオールをアップデートしました。アップデート内容は以下のとおりです。新API: 日本の祝日API 郵便番号逆引き検索API: 品質の改善祝日や休日のAPIについて、機能要望アンケートを募集中です！新API: 日本の祝日API 日本における祝日は、内閣府が毎年CSVデータを公開しています。しかし、システムで祝日データを利用するとき、CSVをダウンロードし、それをシステムにロードするというのは意外と手間がかかります。手動で更新する場合、手順自体を検証した上で運用ドキュメントを執筆する必要があります。さらに、手動運用によるオペレーションミスのリスクも毎年つきまとうことになります。自動化する場合、特別に祝日が移動するケースなどに対応できるようにしなければいけません。結局のところ手動でも更新できるようにして

greenbow 2022/03/16

リンク

HTTP検索条件、GETにするか？POSTにするか？ | フューチャー技術ブログ

はじめにTIG DXユニット 1真野です。 RESTfullとかRESTishな方針でWebA PIの横断検索を設計する際にチーム内で方針について議論したやり取りの備忘記事です。注意としてB2C向けなWeb APIを提供するというよりは、主に企業間または企業内部で使われるようなAPIの設計のバイアスがあります。LSUDs（Large Set of Unknown Developers）かSSKDs（Small Set of Known Developers）で言えば、確実にSSKDs脳で記事が書かれています。 REST API広く使われているため日本語記事も多数です。実践RESTful HTTP - InfoQ や、0からREST APIについて調べてみたなど良さそうな記事が沢山でてくるの読むと良いでしょう。一般的な設計方法はやや古いですがWeb API: The Good Parts

greenbow 2021/05/19

個人的にはGETでリクエストボディあり、が意味的にもしっくりくるから好き。でもライブラリが対応してなかったりするので結局POSTに落ち着く。

API
設計

リンク

Web API 設計のベストプラクティス - Azure Architecture Center

ほとんどの最新の Web アプリケーションでは、クライアントがアプリケーションと対話する際に使用できる API を公開しています。適切に設計された Web API には、次をサポートする目的があります。プラットフォームの独立。 API の内部的な実装方法に関係なく、すべてのクライアントが API を呼び出すことができる必要があります。そのためには、標準プロトコルを使用し、クライアントと Web サービスが交換するデータの形式に同意できるメカニズムを備えている必要があります。サービスの進化。 Web API はクライアントアプリケーションから独立して進化し、機能を追加できる必要があります。 API の進化に伴い、既存のクライアントアプリケーションが変更なしに引き続き機能する必要があります。クライアントアプリケーションが機能を十分に使用できるように、すべての機能が検出可能である