REST API設計のパターンと原則｜Sachiko Kijima｜note

2022/10/25 246 users REST Note 原則 パターン

APIの設計って意外と移り変わりがあるんです。例えばAPIのバージョンの指定方法がヘッダーを使う方法からURLを使う方法にだんだん統合されてきました。 したがって本やスライドなど、その時点のベストプラクティスを読むよりは、生きているベストプラクティスを読んだ方が良いと思います。 ここではいくつか参考になるリ... 続きを読む

Netflixにおける実用的なAPI設計: gRPCとFieldMask | pyspa

2021/10/17 447 users grpc pyspa Netflix

Netflix Tech BlogのgRPC APIに関する以下の２つの記事に感銘を受けたので、ここにその概要を日本語で記します。 (めんどくさかったので)翻訳の許可は取ってませんが、再構成してますし元のJavaではなくPythonで書き直していますので、容赦して下さい… Practical API Design at Netflix, Part 1: Using Protobuf FieldMa... 続きを読む

マイクロサービスのための綺麗なAPI設計 by Go Takagi | Wantedly Engineer Blog

2016/08/17 663 users Wantedly Engineer Blog

1. マイクロサービス化をすすめるにあたり、 やりとりは全てAPIで行う 2. APIのRequestは一括で Gateway(Kong) が受けとり、Gatewayが内部のAPIに渡す 3. 内部のAPIであっても外部に公開できるようなクオリティのAPIを作成し、サービスを構成する 今回は、この方針を推し進めるにあたり、現在多くの媒体で 主流なRESTfulなJSONのAPIをどう設計していくか... 続きを読む

5分で絶対に分かるAPI設計の考え方とポイント (1/6) - ＠IT

2015/11/17 592 users HTTPリクエスト API アプリケーション オマケ 自社

API設計を学ぶべき背景と前提知識、外部APIと内部API、エンドポイント、レスポンスデータの設計やHTTPリクエストを送る際のポイントについて解説する。おまけでAPIドキュメント作成ツール4選も。 【0分】API設計を学ぶべき背景と前提知識 APIの公開が増えている 最近、自社で保有するデータや、システム、アプリケーション、Webサービスの機能を「API（Application Programm... 続きを読む

API設計に関する10のワーストプラクティス « A-Listers

2013/01/11 131 users ワーストプラクティス A-Listers プラクティス 昨今

過半数の開発者が平均で3つ以上のAPIのインテグレーションを実装していると言われている昨今、「使い辛い設計のAPI」を実装するのは開発者にとっては頭の痛い問題ではないでしょうか？ Programable Web上に投稿されたAPIのワーストプラクティスに関する記事が国内外の開発者の目に止まったようです。この記事によると悪いAPIに見られるプラクティスは下記のようなものだそうです。 貧弱なエラーハン... 続きを読む