APIを設計する前に読みたいガイドラインまとめ | NTT Communications Developer Portal
APIというのは主に外部の開発者が見ることになります。そしてその設計思想が彼らの思いとマッチしていないと使うのを嫌がられることになります。逆にエレガントで統一性のあるAPIは開発者を刺激し、使おうという姿勢に変えてくれます。 そこで今回は多くのAPIを提供している各社がリリースしたAPIガイドラインを紹介します。 interagent/http-api-design: HTTP API design guide extracted from work on the Heroku Platform API Herokuが実践しているAPIデザインガイドになります。ステータスコード、リソース、タイムゾーン、パスの付け方、バージョニングなど数多くの項目に渡って記述されています。 API開発指針 | EC-CUBE3 国産Eコマースシステム、EC-CUBE3におけるAPI開
【徹底解説】REST VS GraphQL
注意：今回の記事で載せているコードは読者に具体的なコードのイメージを持たせる目的で書いている。それ故に、実際にブラウザ上で実行しても動作しない点には注意してほしい。より専門的ににGraphQLとRESTの違いを学びたいならLogRocketの記事とApolloの記事を参考に。 はじめに 今回の記事では、Web APIの開発に重宝されるRESTとGraphQLの違いを解説する。 対象とする読者 これからREST、またはGraphQLを実務で積極的に活用したいひと 両者の違いがわからないひと 個人開発等でWeb APIをつくるひと タイトルを見てなんとなく気になったひと APIとは RESTとGraphQLの議論に入る前に、まずはAPIについて説明する必要がある。 Wikipediaによると、API(Application Programming Interface)は以下のように定義されてい
RESTful APIのURI設計(エンドポイント設計) - Qiita
HTTPメソッドとURI HTTPメソッドとエンドポイントは切っても切れない関係にある。URIがリソースを表すものだとすると、HTTPメソッドは操作(何をするか)を表すものである。1つのURIのエンドポイントに異なるメソッドでアクセスすることで、情報を取得するだけでなく情報を変更したり、削除したり等のさまざまな操作を行うようにすることで、リソースとそれをどう扱うかをきちんと分離して扱うことができる。これはHTTPメソッドの本来の考え方に合致しており、Web APIではこの考え方に沿って設計を行うことが主流となっている。各HTTPメソッドについては以下を参照。 リソース指向アーキテクチャの統一インターフェース URI設計 リソースにアクセスするためのURI設計の注意点 1.複数形の名詞を利用する 基本的にリソースは「集合」を表すものであるため、複数形の方が適切である。また、HTTPのURIは
axios、async/awaitを使ったHTTPリクエスト(Web APIを実行) - Qiita
const axios = require('axios'); const url = "https://qiita.com/api/v2/items"; axios.get(url).then(res => { const items = res.data; for (const item of items) { console.log(`${item.user.id}: \t${item.title}`); } }).catch(error => { const { status, statusText } = error.response; console.log(`Error! HTTP Status: ${status} ${statusText}`); }); hp_kj: postgres 公式サイト データベースサンプル dvdrental jhfgjfgjhghj: JP
grpc-gatewayの開発に学ぶ、ソフトウェアの設計手法〜Yuguiが定めた、2つの基本設計方針 - エンジニアHub｜若手Webエンジニアのキャリアを考える！
grpc-gatewayの開発に学ぶ、ソフトウェアの設計手法～Yuguiが定めた、2つの基本設計方針 良いソフトウェアとはどのような方針のもとに設計されているのでしょうか。広く使われているOSSであるgrpc-gatewayの開発過程を作者のYuguiさんが振り返り、その設計手法を解説してもらいました。 こんにちは。 Yuguiと言います。 本記事では読者がより良いソフトウェア設計を行うための参考として、筆者が経験してきた設計上の決定をご紹介します。 筆者はこれまでRuby 1.9のリリースマネジメントを担当したり、Google Mapsの日本向け地理データ処理やgrpc-gatewayの開発などをしてきました。そしてこれらを通じて、広く長く使われて拡張されていくソフトウェアを設計するための方針決定に携わったり、方針に関わる良い議論を目にしたりする機会に恵まれてきました。中でも本記事では、
REST入門 基礎知識 - Qiita
REST入門 基礎知識 はじめに RESTサービスを開発するにあたって勉強したことをまとめました。RESTとはなんぞやというところについて書いていきます。実際の開発方法等については当記事では触れません。 RESTとは REST(REpresentational State Transfer)はWebサービスの設計モデルです。RESTなWebサービスは、そのサービスのURIにHTTPメソッドでアクセスすることでデータの送受信を行います。 例としてQiitaのREST APIを利用してみます。下記のURLにアクセスしてみてください。(ChromeかFirefoxでないと*.jsonファイルのダウンロードになる場合があります) https://qiita.com/api/v2/users/TakahiRoyte {}でくくられている文字が表示されたかと思います。これは JSON(JavaScri
Django REST Framework における API 実装プラクティス | PyCon JP 2018
The document discusses various topics related to APIs and pagination in Django REST Framework. It covers: 1. Pagination techniques in Django REST Framework including PageNumberPagination, LimitOffsetPagination, and CursorPagination. 2. Rate limiting techniques including AnonRateThrottle, UserRateThrottle, and ScopedRateThrottle. 3. Authentication techniques including TokenAuthentication and the dj
GraphQL at Twitter
Tom Ashworth (@tgvashworth) is a software engineer on the core services team at Twitter. Tom's going to give us a whirlwind tour of how GraphQL fits into the architecture at Twitter. We're going to cover: The Twitter GraphQL API and how it fits into Twitter's microservices architecture Subscriptions architecture Twitter's schema and plan for GraphQL in the long term API Twitter started experimenti
Swagger CodegenでPHPクライアントを生成する - GeekFactory
Swagger Codegenが生成するPHPクライアントを使う機会があったので、使い方を記事に残しておきます。 Swagger Codegenが生成するファイル Swagger CodegenでPHPテンプレートを指定すると、以下のファイル群が生成されます。 SwaggerClient-php/ autoload.php composer.json lib/ Api/ APIクライアントのクラス群（例: PetApi.php） Model/ モデルクラス群（例: Pet.php） Petstoreの例が参考になります。 swagger-codegen/samples/client/petstore/php at master · swagger-api/swagger-codegen · GitHub から参照できます。 APIクライアントの使い方 APIクライアントのインスタンスを生成
GitLabからwebhook+PHPで超簡易自動デプロイシステムを作る - Qiita
GitLabのreleaseブランチにpushイベントがあったとき（⊃ マージされた時）にreleaseブランチに自動反映できるようにします。 GitLab CI等のCIツールを入れるほどじゃない小さなアプリケーションを複数人で高速にサクッと開発していきたいときには、これぐらいでもいいのかなと考えています。 スクリプトは非常に簡単にPHPで書きます。 初心者向け：そもそもWebhookって何？ 特定のアクションをトリガーとしてある指定したURLにHTTPリクエストを送ることのできるAPIのことです。 GitLabのwebhookではpushイベントをトリガーにできるので、 あとはURLだけ指定すれば決まったリクエストがpushイベントのたびに送られます。 これを使うと、特定のブランチにpushイベントが有ったときに何らか動作をさせる、という動作が可能になる、というわけです。 ぱっとググッた
Geolocation API removed from unsecured origins in Chrome 50 | Web Updates - Google Developers
Chrome has public intent to deprecate powerful features like geolocation on non-secure origins, and we hope that others will follow. Starting with Chrome 50, Chrome no longer supports obtaining the user's location using the HTML5 Geolocation API from pages delivered by non-secure connections. This means that the page that's making the Geolocation API call must be served from a secure context such
Kazuho's Weblog: ウェブページの描画 (first-paint) までの時間を測定するツールを作った件、もしくはHTTP2時代のパフォーマンスチューニングの話
ウェブページの描画 (first-paint) までの時間を測定するツールを作った件、もしくはHTTP2時代のパフォーマンスチューニングの話 ウェブページの表示までにかかる時間をいかに短くするかってのは、儲かるウェブサイトを構築する上で避けて通れない、とても重要な要素です。 少し古いデータとしては、たとえば、ウェブページの表示が500ミリ秒遅くなると広告売上が1.2%低下するというBingの例なんかも知られているわけです。 「ウェブページの表示までにかかる時間」と言った場合、実際には以下のようないくつかのメトリックがあります。 イベント 意味
Prometheus: Go言語で書かれたモニタリングシステム - ワザノバ | wazanova
https://developers.soundcloud.com/blog/prometheus-monitoring-at-soundcloud 1 comment | 0 points | by WazanovaNews ■ comment by Jshiike | 約1時間前 Prometheusは、SoundCloudが中心となって開発を進めているオープンソースのプロジェクト。Dockerの社内でもメインのモニタリングシステムとして利用されているようです。 各社のブログのエントリーから、その特徴をまとめると。 多元データモデルとそれを活かす柔軟なクエリ言語 全てのデータにタイムスタンプのある、OpenTSDBに準じたデータモデル。 http_response_500_totalやhttp_response_403_totalなどHTTPレスポンスのステータスごとに用意しなくても
Mac始めて6年目にして、使い続けている開発ツール73選 - Qiita
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? 先日Macを再インストールするに当って、いい機会なので使ってないツールを省き使っているツールを厳選してインストールすることにした。あまり増やす気はなかったが、使うものだけ入れても73個になった。 コマンドライン ツール管理 brew-cask: HomebrewでMacアプリをインストールできる。 brew-gem: Homebrewでgemツールをインストールできる。 brew-pip: Homebrewでpipツールをインストールできる。 npm: Node.jsのパッケージ管理ツール。 DevOps ansible: Python
API設計に関する10のワーストプラクティス | gihyo.jp
ソーシャル機能の実装など外部サービスのAPIを使ったアプリケーションが増える中、「使いづらい設計のAPI」は、開発者にとっては頭の痛い問題ではないでしょうか？ Programable Web注1上に投稿されたAPIのワーストプラクティスに関する記事が国内外の開発者の目に止まり話題になっています。この記事によると悪いAPIに見られるプラクティスは次のようなものだそうです。 貧弱なエラーハンドリング HTTPのルールを無視したREST API 裏に潜んだ生のデータモデルの露出 セキュリティの複雑さ ドキュメント化されていない予期せぬリリース 貧弱なデベロッパエクスペリエンス MVC（Model-View-Controller）フレームワークが良いAPIにしてくれるという思い込み 開発すれば使ってもらえるとみなすこと 不十分なサポート 貧弱なドキュメント 自分自身のサービスがAPIを公開する場
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
RESTfulとは