タグ

APIに関するgreenbowのブックマーク (7)

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

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

    RESTful のウェブ API 設計で避けるべき 6 つのよくあるミス | Google Cloud 公式ブログ
  • 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を具体的に挙げるとしたら、マウスやキーボードだろう。WindowsmacOSなどのOSで世の中のマウスやキーボード

    Nintendo SwitchコントローラーにWebアクセス、なぜ可能なのか
  • 日本の祝日APIをリリースしました - ケンオールブログ

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

    日本の祝日APIをリリースしました - ケンオールブログ
  • 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

    HTTP検索条件、GETにするか?POSTにするか? | フューチャー技術ブログ
    greenbow
    greenbow 2021/05/19
    個人的にはGETでリクエストボディあり、が意味的にもしっくりくるから好き。でもライブラリが対応してなかったりするので結局POSTに落ち着く。
  • Web API 設計のベスト プラクティス - Azure Architecture Center

    注意 このページにアクセスするには、承認が必要です。 サインインまたはディレクトリの変更を試すことができます。 このページにアクセスするには、承認が必要です。 ディレクトリの変更を試すことができます。 RESTful Web API の実装は、Representational State Transfer (REST) アーキテクチャの原則を使用して、クライアントとサービス間のステートレスで疎結合のインターフェイスを実現する Web API です。 RESTful である Web API は、リソースに対して操作を実行し、ハイパーメディア リンクと HTTP 操作状態コードを含むリソースの表現を返す標準 HTTP プロトコルをサポートしています。 RESTful Web API は、次の原則に従う必要があります。 プラットフォームに依存していません。つまり、クライアントは内部実装に関係なく

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

    12. SSKDsとは ・Small Set of Known Developers ・特定のシステムのみで利用する専用のAPI 例:自社サービス、社内システム ・用途が決まっているので、 データの種類よりも画面別、アクション別に エンドポイントを定義する傾向にある 一般的にAPIというと LSUDs のイメージが強いので、 DBを抽象化したAPIを作りたがる人もいるが、 リソース指向のリソースはDBのテーブル単位とは限らない リソースとは利用者の要求を満たすデータ 1画面の表示に必要なデータの集合体もリソースになる

    REST API のコツ
  • api-guidelines/Guidelines.md at master · microsoft/api-guidelines

    You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert

    api-guidelines/Guidelines.md at master · microsoft/api-guidelines
  • 1