RESTful のウェブ API 設計で避けるべき 6 つのよくあるミス | Google Cloud 公式ブログ
※この投稿は米国時間 2022 年 12 月 1 日に、Google Cloud blog に投稿されたものの抄訳です。 オンラインで、組み立て式のテーブルを注文したとします。ところが、パッケージを開けてみると、組立説明書が入っていません。完成品がどんなものかはわかっていても、それぞれのパーツをどう組み立てればいいのか、まるでわかりません。設計が不十分な API を使うコンシューマ開発者も、同じような経験をしているといえます。適切に設計された API なら、容易に見つけ、検索してアクセスし、使用することができます。高品質の API は、コンシューマ開発者がアイデアをひらめき、新しいユースケースを作り上げる手助けになってさえくれます。 もちろん、API 設計を改善する方法はあります。たとえば、RESTful のプラクティスに従うなどです。しかし、お客様が知らず知らずのうちに、ちょっとした不便
RESTful APIのPOSTやPUTのレスポンスで、なんで登録や更新した情報を返すの？ - Qiita
前回に引き続き、会社恒例の3泊4日のプログラミングキャンプで、 RESTful APIの設計の際にRESTful APIのPOSTやPUTのレスポンスについて、 思ったことがあったので投稿してみました。 RESTful APIの設計をチームの先輩がSwaggerで作成してくれるということで、 完成したものを確認していると... （ふむふむ、一覧を取得するときのpathはこれで、一覧のレスポンスはこんな感じで返せばいいのか） （新規作成するときのpathはこれで、新規作成が成功した場合のレスポンスはこんな感じで返せばいいのか） （ん？あれ、新規作成のレスポンスに、登録した情報をレスポンスとして返してるな） （でも、新規作成した後は、一覧画面に遷移するから、登録した情報を返しても使わないんじゃないか？) っと思ったので、作成してもらった先輩に質問してみた。 僕 「すみません、新規作成が成功した
今さら聞けない REST とリソース指向 - Mirai Translate TECH BLOG
概要 こんにちは。プラットフォーム開発部でリードエンジニアをしているchanceです。 私たちのチームでは現在、開発部内向けの API 設計ガイドラインを整備しようとしています。 API 設計において、REST は基本中の基本です。ガイドラインとしてまとめるからには適当なことは書けませんので、改めて REST の原則から確認しました。新しい技術を追いかけるのはもちろん重要ですが、こういった基本の技術をしっかりと理解することも同じように重要です。 この記事では、調べた内容のシェアとして、REST の誕生から原則、リソース指向アーキテクチャの概要や特性などを解説します。文字文字しくなってしまいましたが、ご容赦ください。 概要 REST の誕生 REST の原則 原則はいくつあるのか 書籍「RESTful Web Services」 ROA（リソース指向アーキテクチャ）について ROA（リソース
REST APIアーキテクチャとMVCアーキテクチャの違い - NRIネットコムBlog
本記事は 執筆デビューWeek 10日目の記事です。 ✨ 9日目 ▶▶ 本記事 ▶▶ 11日目 🔰 初めに MVCとREST APIの違い ビュー層の構成 認証・認可アーキテクチャ サービス構成 REST API+SPA構成のメリット/デメリット MVC構成のメリット/デメリット 総括 最後に 初めに 初めまして。9月にキャリア入社した芳賀と申します。前職ではオンプレミス環境+MVC構成のWebアプリのエンジニアをしておりました。現在はAmazon ECS+REST API（Spring Boot）+SPA構成のバックエンドエンジニアをしており、入社前後でアーキテクチャ構成がかなり変わって四苦八苦しております(笑) そこで、2か月間の経験をもとにMVC/REST APIの差で困ったポイントをまとめてみました。今後アーキテクチャ変更に取り組まれようとしている方の一助になればと思います。 M
GraphQLのよくないところ｜adwd
銀の弾丸ではないので良し悪しあるのは当然として、それを差し引いても以下の2つの要素があるのではと思った。 なんとなく使ってもメリットが十分得られない RESTでできてたことができなくなる（※ちゃんと調べればできる） なんとなく使ってもメリットが十分得られないWeb界隈は良くも悪くも新しい技術をとりあえず使ってみるところがあると思っていて、そこがGraphQLは十分に事前知識を持って導入しないとメリットが薄いところとミスマッチを起こしてネガティブな意見が出るのかなと思う。 GraphQLはもともとFacebookがReact, Relayとの組み合わせで使い始めたもので、クライアントライブラリとしてのRelayと、IDやページネーションについての追加仕様を公開している。ライブラリとしてのRelayは使わなくても仕様に乗っかることはできるのでそれをRelayスタイルと言ったりする。出典を忘れた
GraphQLとは何か？ イメージを掴む
はじめに 今回の記事ではGraphQLについて、公式などを参考にしながら基本的なことをまとめてみました。 自分自身GraphQLのキャッチアップを始めるときに こんなこと知っときたかったなあ、ということをまとめたので これからGraphQLの勉強を始める方や興味のある方はよかったら読んでみてください。 大枠を掴むことをイメージして書いており、深い部分の説明を省いている箇所もあるので その点はご了承ください。 そもそもGraphQLとは？ GraphQLはAPIのクエリ言語です。 クエリ言語というとSQLが有名ですが、SQLがデータベースに対してクエリを実行するのに対し、 GraphQLはAPIに対してクエリを実行します。 ちなみに、プログラミングにおけるクエリとは データに対する問い合わせや要求などを一定の形式で文字に表現すること、 要は所定の形式で対象のデータにやりたいことを伝えること、
すべての Web サービス設計者に捧ぐ「RESTful って結局なんなんだ」
誰もがその戦いの背景にある歴史の深淵と人々の覚悟を見誤っていた。開戦初日に決着が付くと高を括って鼻歌混じりに筆を取った私は、気が付けば夏休みの８割を喪失し、すべての指が腱鞘炎で悲鳴を上げる中で参考文献の海に這いつくばっていた。 —— Josh Nobus —— ぜんぜんわからない 俺たちは雰囲気で REST をやっている 何度調べてもなんだかよく分からない概念ランキングの個人的 Top5 に入る言葉。 それが「REST」だ。 いろんな Web サービスの REST API はよく使わせてもらっているし、REST API が何かと聞かれれば「その Web サービスの機能を HTTP リクエストで呼び出せる API エンドポイントのことだよ」みたいにそれっぽくお茶を濁すことはできると思うが、じゃあ自分で RESTful なサービスを作ってみろと言われたら私は作れない。作れなかった。 だってどん
GraphQLはいつ使うか、RESTとの比較
さぼです、沖縄でWebと設計について考えてます。2023/09/23 に沖縄で行われたTechBaseOkinawa2023 にて上記のタイトルで登壇しました。 今回の内容は GraphQLを設計の観点から考えてみる GraphQLの目的や用途を整理する GraphQLを使う時、または使わない時のヒントを持ち帰ってもらう 最近、GraphQLじゃなくてRESTで良くないと思うケースがなんとなくわかってきたのでそれを共有する という感じで話しました。話した内容を文字に起こし少し改修してZennでも共有することとします。 まえおき 最近はクライアントAppとサーバーAppを分けて実装する事が増えてきた クライアントの環境はますます複雑になっている クライアントとサーバーはWebAPIで通信を行う クライアントが複雑になるのと同時にWebAPIの要求が更に増して来ている APIの要求・応答を効率
REST API用のファジングツール “RESTler” で始めるお手軽ファジング | IIJ Engineers Blog
IIJイノベーションインスティテュートの四谷です。普段はWeb API開発の生産性向上についての調査や開発を行っています。 今日はREST APIのテスト効率を改善するツール「RESTler」を紹介します。 RESTlerについて RESTlerはMicrosoft Researchが開発し、OSSとして公開しているREST API用のファジングツール（ファザー）です。 ファジングはネットワークプロトコルの実装等、もう少し下位レイヤーでの活用が主で、APIに対して実行できるファザーは数少ないのですが、その1つがRESTlerです。Microsoftでは実際にRESTlerを使用して、AzureやOffice365のバグを検出したそうです。 特長 RESTlerの最大の特長は、OpenAPIドキュメントとして記述されたAPI仕様さえあれば、自動的にテストケースが生成され、ファジングを実行でき
REST API開発に特化したWebフレームワークがもたらす生産性の向上 | IIJ Engineers Blog
皆さんはREST APIの開発にどのようなフレームワークをお使いでしょうか？ これまで、個人的には Flask 等の軽量なWebフレームワークを使って開発することが多く、REST API開発に特化したWebフレームワーク（以下、APIフレームワークと呼ぶ）を使った経験はありませんでした。 しかし先日、業務で Django REST Framework に触れる機会があり、REST APIの実装に必要な機能の多くが提供されていて、圧倒的に少ないコーディング量で開発が完了することを実感できました。例えば、フィルタリング（URLクエリストリングで検索条件等を指定し、取得する値を絞り込む）機能は、一から実装するとなると文字列をパースして、バリデーションして、クエリに渡して……、と結構面倒ですが、Django REST Frameworkではビルトイン機能として提供されているので、最小限のコードで実
Django REST framework カスタマイズ方法 - チュートリアルの補足 - Qiita
この記事について Django REST frameworkはデータベース連動のREST APIを最小限の労力で作れるフレームワークです。 すでに日本語のチュートリアルの良記事がいくつかあって、内容通りに進めればサービスの公開まで迷わずに進めることができます。 しかし業務で使うとなるとチュートリアルの内容では物足りなく、機能やセキュリティの面でもう少し複雑な設定が必要になります。公式サイトで調べたカスタマイズ方法をまとめておきます。 チュートリアル集 Django REST Framework の基本が学べます。どれもわかりやすいです。爆速！ Django REST Frameworkを使って爆速でAPIを実装する Django REST frameworkで爆速API開発 導入編 - OfferBox Tech Blog Django REST Frameworkに再挑戦 その1 - D
今度こそ (REST) API Gateway と仲良くなるための個人的まとめ | DevelopersIO
はじめに おはようございます、もきゅりんです。 早速ですが、当記事では、API Gatewayの使い方の詳細や、こんな使い方が良き、というお話は一切ありません。 API Gateway(RESTに限った話です)と仲良くなりたいわたしによる、API Gatewayの全体像の捉え方を個人的にまとめたものとなります。 他の方にお役に立つかどうかは分かりません。。 でも、もしあなたがわたしと同じように、API Gatewayと仲良くなりたいとは思っているんだけど、ドキュメント読んだり他の人の紹介記事を見て実際にやってみたりしても分かったような気がするけど、仲良くなった気がしない、、という方は、一助になるかもしれません。 ということで、いちおうAPI Gatewayがどんなものか何となくは把握されている方が対象です。 単純化してイメージしてみる 物事の学習において肝要なのは、まず全体像を把握すること
マイクロサービスとメッセージングのなぜ [概要編] - 赤帽エンジニアブログ
レッドハットでインテグレーションのためのミドルウェアのテクニカルサポートを担当している山下です。 最近はマイクロサービスでシステムを開発しているという話もよく聞くようになってきました。ではそこでメッセージング、そしてKafkaを使ってますでしょうか？マイクロサービスでは何故かRESTばかりが世の中に注目されてしまうことも多いために、今回はメッセージング推しの内容にしています。 マイクロサービスではメッセージングを用いたコマンドやイベントこそ中心であって不可欠です。マイクロサービスの中でメッセージングはどのように利用され、そしてなぜ必要なのでしょうか。今回は「マイクロサービスとメッセージングのなぜ [概要編]」と題してそれを概観していきます。 Kafkaの簡単なおさらい どこでメッセージングは利用されるのか？ RESTはお手軽な解決策？ なぜマイクロサービスにメッセージング(Kafka)が必
![マイクロサービスとメッセージングのなぜ [概要編] - 赤帽エンジニアブログ](https://cdn-ak-scissors.b.st-hatena.com/image/square/707ca04fc1adae69cf6e76dabc92e34469792eec/height=288;version=1;width=512/https%3A%2F%2Fcdn-ak.f.st-hatena.com%2Fimages%2Ffotolife%2Ft%2Ftyamashi-oss%2F20190724%2F20190724112428.jpg)
【第10回】Go言語（Golang）入門～ObjectBox活用編～ – 株式会社ライトコード
package main import ( "go_example/model" "net/http" "time" "github.com/labstack/echo" "github.com/objectbox/objectbox-go/objectbox" ) func main() { e := echo.New() e.POST("/add", addFavorite) e.Logger.Fatal(e.Start(":1323")) } func addFavorite(c echo.Context) error { favorite := new(AddFavoriteRequest) // データ受け取り if error := c.Bind(favorite); error != nil { return error } // initialize ob := initO
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GraphQLはどんな時に使うか
GitHub - microsoft/api-guidelines: Microsoft REST API Guidelines
api-guidelines/Guidelines.md at vNext · microsoft/api-guidelines
Home
RESTの力 / The Power of REST
GitHub - valeriansaliou/bloom: :cherry_blossom: HTTP REST API caching middleware, to be used between load balancers and REST API workers.
