トリプル・ダブリュー・ジャパン株式会社でソフトウェアアーキテクトをしています西田です。ネット上では主にkbigwheelの名前で活動しています。 今回は最近私達のチームで行ったRFC7807に沿ったエラーレスポンスの実践について紹介します。 RFC7807とは 2016年にIETFから発行された、新しいHTTP APIのエラーレスポンス形式*1です。 日本語の解説記事は非常に少ないですが、こちらのブログで非常にわかりやすく要所を日本語に翻訳しつつ説明されています。 HTTP APIの詳細なエラー情報をレスポンスに持たせるための仕様 この標準に沿うことで新しい開発メンバーへ仕様を共有することが簡単になります。 また過去にこの仕様を見たことがあれば、新たに勉強することは最小限で済みます。 サーバサイドチームの取り組み 私が所属するサーバサイドチームでは11月にAPIサービスの大幅なバージョンア

Omitted from the table are tests with the 1,000,000th offset and above since they consistently timed out. Not only do queries take a long time when a large offset is used, but there’s also a limited number of queries that can be run concurrently. If too many requests with large page numbers are made at the same time, they can pile up faster than they can be executed. This leads to unrelated, quick

App Dev Best Practices architecture Modernization Best Practices prac_design prac_eng prac_pm Product Development Tanzu Labs Principles of Designing & Developing an API Product [Part 1 of 4] This post was authored by Caroline Hane-Weijman, David Edwards and Francisco Hui Through APIs, we can access the power of billions of dollars of functionality built by others to radically accelerate our produc

この記事はMERPAY TECH OPENNESS MONTHの10日目の記事です。 こんにちは、メルペイのバックエンドエンジニアの柴田（@yoshiki_shibata）です。 メルペイのバックエンドは、Google Cloud Platform上でGoogle Kubernetes Engineを使用して、マイクロサービスアーキテクチャを採用した多数のマイクロサービスから構成されています。モノリシックなサービス実装では複数層のライブラリ（あるいはコンポーネント）から構成されるのに対して、マイクロサービスアーキテクチャでは複数層のマイクロサービスから構成されます。 どちらのアーキテクチャにおいても、偶発的プログラミング（Programming by Coincidence）1を避ける2ために、注意を払って作成する必要があるのが、境界部分のAPI（Application Programmi

Kibelaのデータを扱うためのWeb APIを開発中でしたが、先日そのベータ版を公開しました。 仕様等の詳細につきましては、こちらのGitHubのページをご覧ください。 github.com なお、ベータ版のため、事前の告知等なく仕様の変更を行う場合や、大きな不具合がある可能性があることもご承知置きください🙇‍♂️ また、ご要望等がございましたら、画面右下のチャットからではなく、上記GitHubのIssuesに投稿いただくようお願いいたします。 正式版のリリースに向けて不足しているAPIの追加や不具合の修正等を行ってまいりますので、ぜひ試用いただきフィードバック等をいただければ幸いです🙏 よろしくお願いいたします！

Saved by the Schema: Using JSON Schema to Document, Test, and Debug APIs Heroku has many public API endpoints. Each of these endpoints needs to be tested so that we know how they work, and documented so that our customers (and other API consumers) know how they work. Follow along, and we’ll learn how Heroku uses JSON Schema to test and document our Platform API – and how it helped us uncover an un

印刷する メールで送る テキスト HTML 電子書籍 PDF ダウンロード テキスト 電子書籍 PDF クリップした記事をMyページから読むことができます 前回は、APIの認証と認可をスケールする手法について説明した。第3回の本稿では、APIのキャッシュの活用と過度なリクエストを制御する手法について解説しよう。 エッジでAPIのアクセスを制御するモチベーションの1つがキャッシュであり、特に検索系APIでは有効だ。エッジでAPIキーやJWT（JSON Web Token）を検証し、認可されたリクエストのみがオリジンのAPIサーバにフォワードされるが、毎回オリジンにリクエストが届くと、ユーザー体験が悪くなってしまう。以下に、APIのレスポンスをキャッシュすべき7つの理由を挙げる。 多くのAPIは読み取りに対するリクエストである バックエンドのデータベースが変わらなければ応答結果も変わらない ク

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

Internet Engineering Task Force (IETF) M. Nottingham Request for Comments: 7807 Akamai Category: Standards Track E. Wilde ISSN: 2070-1721 March 2016 Problem Details for HTTP APIs Abstract This document defines a "problem detail" as a way to carry machine- readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs. Status of This Memo This is

Schema Driven DevelopmentLong Story Short (-_-)zzzBuilding APIs can be a difficult and painful process. Cross-team collaboration is required and the post development back and forth is almost always expected. If you care about quality and efficiency, there is a better way to develop APIs that will make your dev life more pleasant. By being more proactive in the initial stages of the development, yo

参加対象者が「製品やサービスをProduct Manager、Product Owner、製品企画として運営する方で「API」が守備範囲の方」！ 「サイボウズ・Sansan・CloudSign・freee」現在のクラウドサービス最前線でAPIに関わるPMの方々が自社のAPIの狙い、戦略、苦労を語る、というかなり舵を振り切った勉強会、API x PM #01に参加してきました。 apipm.connpass.com こんなところでやりました 会場は サイボウズ　東京オフィスでした。こんな感じでおしゃれなカフェみたいなところ！ API を担当するPM たちの集いAPI x PM #01　が19:00 から始まります〰。 サイボウズさん場所提供感謝です。#apipm pic.twitter.com/pSqUaeXOyc— keisuke hikita (@hornets79) 2018年7月3日

フィードバックを送信 API 設計ガイド コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。 変更履歴 はじめに これは、ネットワーク API の一般的な設計ガイドです。2014 年以来 Google 内部で使用され、Cloud API やその他の Google API を設計するときに Google が従うガイドです。この設計ガイドは、外部のデベロッパーへの情報提供と、互いの連携作業の効率化のためにここで共有されています。 Cloud Endpoints のデベロッパーには、このガイドは、gRPC API を設計するときに特に役立つことがあり、そのような場合にはこれらの設計原則を使用することを強くおすすめします。ただし、このガイドの使用は必須ではありません。Cloud Endpoints と gRPC はガイドに従わなくても使用できます。 このガイドは、gR

Web API開発において、エラーをどういう形式で返却するか、というのは設計する際の悩みポイントかもしれません。エラーレスポンスの仕様の1つとして RFC7807 Problem Details for HTTP APIs があります。 この形式をサポートしつつ Rails や Sinatra でも使える Ruby ライブラリをこの度作りましたのでそのご紹介。その名も ProblemDetails. 本記事では Rails での使い方について。 ProblemDetailsの機能概要 gem では以下の機能をサポートしています。 RFC7807形式を実装したオブジェクトクラス Railsサポート: problem detail 形式でレスポンスする problem renderer Sinatraサポート: problem render function problem details 形

Internet Engineering Task Force (IETF) M. Nottingham Request for Comments: 7807 Akamai Category: Standards Track E. Wilde ISSN: 2070-1721 March 2016 Problem Details for HTTP APIs Abstract This document defines a "problem detail" as a way to carry machine- readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs. Status of This Memo This is