Web API 設計のベスト プラクティス - Azure Architecture Center
ほとんどの最新の Web アプリケーションでは、クライアントがアプリケーションと対話する際に使用できる API を公開しています。 適切に設計された Web API には、次をサポートする目的があります。 プラットフォームの独立。 API の内部的な実装方法に関係なく、すべてのクライアントが API を呼び出すことができる必要があります。 そのためには、標準プロトコルを使用し、クライアントと Web サービスが交換するデータの形式に同意できるメカニズムを備えている必要があります。 サービスの進化。 Web API はクライアント アプリケーションから独立して進化し、機能を追加できる必要があります。 API の進化に伴い、既存のクライアント アプリケーションが変更なしに引き続き機能する必要があります。 クライアント アプリケーションが機能を十分に使用できるように、すべての機能が検出可能である
自社サービスのWeb API提供に潜むリスクとは 「OWASP API Security Top 10」から見る、脅威とその対策
「Akamai World Tour 2023」はAkamai社が主催する年次最大のユーザーイベントです。2023年9月に開催された本イベントでは、Akamai社が提供するセキュリティ、CDN、クラウドコンピューティングを切り口に、安全で可用性の高いアプリケーションの維持や構築・展開における課題について考察しました。パートナーセッションに登壇したのは、株式会社ラックの山根将司氏。Web APIの提供するメリットと、セキュリティリスクの対策について発表しました。 登壇者の自己紹介とアジェンダの紹介 山根将司氏：「Web APIの提供メリットと、抑えるべきセキュリティリスク」と題して、私、株式会社ラックの山根が発表いたします。お願いいたします。 今回のアジェンダです。まずは、「Web APIって何？」という方向けに、Web APIの概要とその普及の背景を説明していきたいと思います。その次に、W
Webhooks.fyi
Webhooks are the foundation of modern API development. They enable us to react to changes in our systems, an incoming text message, a successful payment, or that latest pull request no matter our stack. While webhooks are universal in concept, they are unstandardized API contracts with few organizations paying attention to their design, security controls, and overall operational experience. Webhoo
Sending and receiving webhooks on AWS: Innovate with event notifications | Amazon Web Services
AWS Compute Blog Sending and receiving webhooks on AWS: Innovate with event notifications This post is written by Daniel Wirjo, Solutions Architect, and Justin Plock, Principal Solutions Architect. Commonly known as reverse APIs or push APIs, webhooks provide a way for applications to integrate to each other and communicate in near real-time. It enables integration for business and system events.
SmithyでAPIリファレンス作成してみよう
はじめに みなさんはじめまして、ニフクラのエンジニアをやっております@seumoと申します🐭 本記事は富士通クラウドテクノロジーズ Advent Calendar 2021の14日目の記事です。 13日目は @tunakyonn🤴のCDK for Terraform をニフクラ provider で試してみたという記事でした。 得意なプログラミング言語でクラウドのリソース管理を自動化できるのはとても便利ですね、私も今度Javaで試してみようかと思います。 Smithyとは SmithyはAmazonが開発したIDL(インターフェース記述言語)に基づくツールセットであり、プログラミング言語やプロトコルに依存せずサービスのインターフェースを定義することができ、さらにその定義から複数のプログラミング言語のコードを自動生成できたりするものです。 SmithyでAPIリファレンスを作成してみる
Web API: The Good Partsを読んだまとめ - Qiita
このドキュメントについて Web API: The Good Partsを読んだ内容を友人とやっている勉強会で発表する際に使う資料としてここにまとめた この本について WebAPIを設計する際のベストプラクティスみたいなのを解説した本 リソース指向とかを事前に知っておくとすんなり入ってくる内容な気がする そんなに厚い本ではなくサラッと読めるのでおすすめ エンドポイントとリクエストメソッドの設計 エンドポイントの設計 筆者が重要だと考える下記にそって設計を行うと良い。 短く入力しやすい 人間が読んで理解できる 大文字小文字が混在していない 改造しやすい サーバ側のアーキテクチャが反映されていない ルールが統一されている それぞれについて説明していく 1.短くて入力しやすい 読んで字のごとく、短くて入力しやすいということは、シンプルで覚えやすく理解しやすいから 2.人間が読んで理解できる 当た
webhook開発は大変だったので話を聞いて欲しい - freee Developers Hub
こんにちは、Public APIチームでエンジニアをしているまっつーです。 趣味は飲酒、特技は多量飲酒、苦手なことは酒に飲まれないことです。 freee Developers Advent Calendar の 5 日目を気合入れて書いていきます。 突然ですがfreeeは今年Webhook機能をリリースしました。 prtimes.jp 現在は会計freee上での経費精算と各種申請の作成、更新をhookに通知を受け取ることができるようになっています。 今までは自分の申請した経費申請が承認されたかどうかをわざわざブラウザを開いて会計freeeにログインして確認しないといけない世界でした しかし、Webhookの登場により自分の申請が承認されたらそれを通知で受け取れる世界になりました。 これがコロナ時代の会計ソフト、ニューノーマルってやつです。たぶん。 WebhookはPublic APIチーム
OpenAPI (Swagger) を利用して効率よく WebAPI の仕様を管理する
Web 開発の現場でよく耳にする言葉として Swagger というものがあります。アプリケーション開発においてサーバー（WebAPI）とデータの送受信を行う機能は不可欠なものとなっている現在、多くの現場ではそのための設計モデルとして REST (REpresentational State Transfer) という方式が使われています。この記事では、REST API の仕様ドキュメントを記述する手段として OpenAPI (Swagger) というものを紹介し、REST Client 機能を備えたインタラクティブな API 仕様ドキュメントを作成・共有する方法についてお伝えしたいと思います。 OpenAPI (Swagger) とは？OpenAPI Specification (OAS) といい、REST API の仕様を記述するためのフォーマットです。また Swagger とは、Ope
(レポート) AWSモバイル/IoTサービス徹底攻略！！ 「Swaggerで始めるモデルファーストなAPI開発」#cmdevio | DevelopersIO
森永です。 11/21（土）に目黒のAWSJにて開催された「AWSモバイル/IoTサービス徹底攻略！！〜Developers.IO Meetup番外編〜」のレポートです！ イベント概要 本勉強会は、基本的な内容のBasic Track、応用的な内容のAdvanced Track、実際に試すことの出来るHands Onの3トラックに分けてAWSのモバイルサービスや、サーバーレスアーキテクチャ、IoTのお話をするというものです。 セッション内容 NRIネットコム（株）佐々木 拓郎さん [slideshare id=55359338&doc=classmethodswagger-151121063232-lva1-app6892] 自己紹介 Amazon Web Servicesパターン別構築・運用ガイドを執筆 AWS関連で一番分厚い本 本の中にクラウドネイティブという名のもとに、クラウドを前提
Swagger 3.0のOAuth認証にCognito User PoolsのOAuth Clientを使う | DevelopersIO
Swaggerとは Swaggerは、RESTful APIを構築するためのオープンソースのフレームワークのことを指します。APIをYAMLで定義でき、実際に呼び出すことができるようなインタラクティブドキュメントを生成できます。Amazon API Gatewayで使われていることでも有名です。 概要については下記のブログを参照してください。 (レポート) AWSモバイル/IoTサービス徹底攻略！！ 「Swaggerで始めるモデルファーストなAPI開発」#cmdevio Swagger 3.0とは Swaggerのバージョンについては、現時点では2系がメジャーですが、3系も正式にリリースされたため、3系で書くケースも増えてきました。なお、API Gatewayは現時点では2系をサポートしています。 3系は、「2系でやりたかったけどできない！」という点が数多く改善され、非常に書きやすくなって
【初心者向け】SwaggerとAWS SAMを使ってWebAPIを簡単に作ってみた | DevelopersIO
応答パラメータの例は下記とします。 { "python": "3.6.2" } AWS SAMプロジェクトの準備 下記コマンドでプロジェクト一式を作成します。 sam init --runtime python3.6 --name SwaggerSample Swagger Editor 導入 こちらを参考に導入します。Dockerは便利ですね。 API定義 Swagger Editorで下記を作成しました。この内容をswagger.yamlとして、AWS SAMプロジェクトフォルダに保存します。 swagger.yaml swagger: "2.0" info: description: "SwaggerとAPI Gatewayのサンプルです。" version: "1.0.0" title: "Swagger Sample" basePath: "/Prod" tags: - name
CORS (Cross-Origin Resource Sharing) ってなに？
先日CORS(Cross-Origin Resource Sharing)でハマったので、今更だけど復習。Same Origin Policy(同一オリジンポリシー)について基本的なところから調べ直しました。 オリジンとは オリジン ＝ スキーム、ホスト、ポートの組み合わせ (※スキームによって微妙に違うこともある) http://www.exsample.com:80/index.htmlのURLを例にすると スキーム ＝ http:// ホスト ＝ www.exsample.com ポート ＝ 80 (ポート番号「80」は省略可なので普段見かけることは少ない) 同一オリジンポリシーとは TL;DR セキュリティを守るための重要な仕組み あるページを開いたときに、関連するリソース(JavaScript等)を同じオリジンからしか取得しない そうしないと個人情報の保護も外部からの攻撃にもガバ
翻訳: WebAPI 設計のベストプラクティス - Qiita
これは Enchant の開発者である Vinay Sahni さんが書いた記事「Best Practices for Designing a Pragmatic RESTful API」1を、ご本人の許可を得て翻訳したものです。 RESTful な WebAPI を設計しようとすると、細かなところで長考したり議論したりすると思います。また、他の API に倣ってやってはみたものの、本当にそれでいいのか、どうしてそうしているのか分からない、何てことも少なくはないと思います。 この記事では、そのようなハマリどころについて Vinay さんなりの答えを提示し、簡潔かつ明快に解説してくれています。 今後 WebAPI を設計される方は、是非参考にしてみてください。 なお、誤訳がありましたら編集リクエストを頂けると幸いです。 まえがき アプリケーションの開発が進むにつれて、その WebAPI を公
Web API 設計のベストプラクティス集 ”Web API Design - Crafting Interfaces that Developers Love”
Apigee Web API Design という本を読みました. Web API 設計のベストプラクティスがまとめられている, apigee という API のソリューションを提供している会社がだしているフリーの ebook です. コンパクトに 30 ページほどに読みやすくまとめられています. 以下要点のメモです. 開発者視点 API の目的はアプリケーション開発者 (API 利用者) が可能な限り成功すること. 開発者の視点で設計すること. 本書ではそのような API を実現する tips を紹介する. Pragmatic REST REST 原理主義はよくない. RESTafarian たるべからず アプリ開発者の利便性が一番大事. 実利的な REST 設計が求められる それを本書では Pragramatic REST とよぶ URL 動詞ではなく名詞 リソースを名詞であらわす.
悪いWeb API設計
[1] Web API (HTTP による API) の悪い設計例やどう設計するべきかの指針のご紹介です。 [138] 何が良いかは諸説あり宗教的で難しいですが、 悪いものには悪い理由があるので賛否はともかく参考になるはずです。 バージョニング (版付け)[2] API にバージョンを設けるべきではありません。 API の拡張は、常に後方互換性を保った形で行うべきです。 [3] 従って URL や HTTPヘッダーなどにバージョン番号を指定させる必要はありません。 [7] やむを得ず非互換変更せざるを得なくなった時は、非互換な機能のみ、 新しいエンドポイントを設けるべきです。はじめから非互換変更するつもりで準備しておくのは無駄ですし、 非互換変更するための言い訳を用意するようなもので、危険です。 [38] バージョンが複数あるということは、同じものを複数メンテナンスし続けなければならないと
Embracing the Differences : Inside the Netflix API Redesign
As I discussed in my recent blog post on ProgrammableWeb.com, Netflix has found substantial limitations in the traditional one-size-fits-all (OSFA) REST API approach. As a result, we have moved to a new, fully customizable API. The basis for our decision is that Netflix’s streaming service is available on more than 800 different device types, almost all of which receive their content from our priv
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
リソース指向の設計 | Cloud APIs | Google Cloud
【連載】Swagger 3.0 入門
Web APIの悪い設計
【連載】APIエコノミーの作り方