はじめに フロントエンドのディレクトリ構成、世の中に色んな「推し」が有って悩みますよね。 例えば、、、 さらに最近は、App Directoryの登場や、それに合わせたNext.js公式の「推し」構成がドキュメント化されたりと、さらに色々なパターンが出てきています。 本記事の趣旨 本記事では、具体的な構成そのものではなく、 様々ある構成を横串で見通して整理できる設計思想を紹介します。 新しい推し構成の紹介ではなく、構成を考えたり決めたりするときに役立つ抽象的・汎用的な指針を提供できればと考えています。 基本となる考え 分割の方向 一般的に、アーキテクチャにおける分割には2つの方向が有ります。 (出典も良書なのでリンクを貼っておきます： https://www.amazon.co.jp/dp/4873119820) これはディレクトリにおいても同じだと思っていて、筆者は分かりやすさのために

このサイトは、只今WEB業界で活躍中のデザイナー、プログラマーの方々の情報を集めたweb統合情報サイトです。 web帳 どもです。 今回は、新規プロダクトの開発の際に、非常に重宝する「JSON Server」についてのご紹介できればと。 真新しいものでもないのですが、よく利用してせっかくなのでまとめさせていただきます。 何か参考になればと。 とある事業で、新規プロダクト制作が立ち上がって、フロントエンド開発を行っていくにも「サーバー側が出来てないよぉ。」 と、言って制作できないところが発生する場面は多々あるかと思います。 そもそも、新規プロダクトで、サーバー側が出来上がっている状態というのは、なかなかない状態かと思います。 そんなときに非常に便利なのが「JSON Server」となります。 「JSON Server」で、仮に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

API のバージョニングは簡単ではありません。いろいろな方法があり、API の世界の人なら誰でも持論をお持ちでしょう。バージョニングを避けることもほとんど不可能です。開発チームが仕事を進めると、機能を廃止（または、その機能を別の形で提供）する必要が生じることがあります。バージョニングを導入すれば、API のユーザーは API のセマンティクスの変化を確実に把握できるようになります。 複数のバージョンを設けないようにする会社もありますが、Google にはそのような余裕はありません。Google の API の数、API を開発しているチームの数、API を使っている開発者の数があまりにも多いので、どのような機能が API に期待されているのか、それを知るための手段として私たちは API をバージョニングしています。 API のバージョニングには一貫性のある包括的なポリシーが必要です。Goo

Is a REST API to spread peace and love (or not) thanks to cats. Have 0 cats for now Give me a cat Hey cat lovers, new major version of cataas : Now JSON will returns if request contain application/json header, API doc updated hereFix tags search and fix tags combined with "," separator (see documentation)

Spring BootによるAPIバックエンド構築実践ガイド 第2版 何千人もの開発者が、InfoQのミニブック「Practical Guide to Building an API Back End with Spring Boot」から、Spring Bootを使ったREST API構築の基礎を学んだ。この本では、出版時に新しくリリースされたバージョンである Spring Boot 2 を使用している。しかし、Spring Boot3が最近リリースされ、重要な変...

HAL (Hypertext Application Language) とは Web API でやり取りされるリソースを、ハイパーメディアとしても扱えるようにするための仕様です。 ハイパーメディアとは HTML のアンカータグをイメージするとわかりやすいですが、ドキュメントといったメディアがリンクを介して繋がっている状態のことを指します。 例えば通常の Web API で取得できるリソース同士は特別何かで繋がっているわけではなく、お互いのリソースがある意味孤立した状態にありますが、そこにリンクを含めてあげることでお互いのリソース間を行き来することが出来るようになります。 HTML と HAL をハイパーメディアの観点で言うと、このような感じになるでしょうか。 HTML: 人間が操作するためのハイパーメディア HAL: 機械が操作するためのハイパーメディア 具体的にリソースを HAL +

本記事はKIT AppDeveloper Advent Calendar 2015の21日目の記事です。 APIの実装が追いついてなくてクライアント側が開発できない？ 開発初期段階の場合だとよくあることだと思います。 APIの設計自体は全体通して済ませてあることが前提として必要ですが レスポンスでどういうものが返ってくるか決まっているのであれば、APIのモックでダミーデータを返すことで、API実装が間に合っていなくともクライアントの開発を進めることができます。 また、クライアント側の開発によってAPI実装の修正が必要なときに、「このようなjsonのデータが欲しい」と伝えるのが簡単で分かりやすくなります。 APIのモックができたらいいこと モックとはモックアップのことで、試作で作る模型のようなイメージです。 では、APIのモックとして何ができると嬉しいかというと最低でも下記のようなことができ

2017-01-05 追記 2016年3月にエラーの標準形式RFC7807「Problem Details for HTTP APIs」が提案され、今日現在proposed standard(標準化への提唱)となっています。こちらも是非ご覧ください。 RFC 7807 - Problem Details for HTTP APIs HTTP APIの詳細なエラー情報をレスポンスに持たせるための仕様 最近はREST APIを提供しているサービスが増えてきていますね！また公開されるAPIだけでなく、Microservicesなアーキテクチャを採用して、バックエンドがWeb APIで通信するケースも増えてきているように思います。 APIを使うときはあまり気にしたこともなかったですが、いざAPIを設計してみるとどんなインターフェイスがいいのか、どんな形式がいいのかといった疑問が次々と出てきます。

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? はじめに APIの勉強のために、Web API: The Good Partsを読みました。平易な日本語で書いてあるので、読みやすかったです。 とはいえ、何度も本を読み返すのは大変なので、自分用まとめも兼ねて書こうと思った次第です。 1個1個まとめていくと結構な量があるので今回は「設計変更しやすいWeb API」についてまとめました。 本でいうと5章に書いてあります。 この記事も参考に Web API: The Good Partsの他のまとめ記事もここに載せておきます。 2.2: Web API: The Good Partsを読んだ

はじめに APIの勉強のために、Web API: The Good Partsを読みました。平易な日本語で書いてあるので、読みやすかったです。 とはいえ、何度も本を読み返すのは大変なので、自分用まとめも兼ねて書こうと思った次第です。 1個1個まとめていくと結構な量があるので今回は「良いURI」とは、についてまとめました。 APIのエンドポイント(URIのこと)を考えるときにURIのことも一緒に考えないといけないので、基礎編として「良いURI」についてまとめました。 本でいうと2.2に書いてあります。 この記事も参考に Web API: The Good Partsの他のまとめ記事もここに載せておきます。 2.6: Web API: The Good Partsを読んだので「OAuthの仕組み」についてまとめた 3章: Web API: The Good Partsを読んだので「レスポンスデ

はじめに APIの勉強のために、Web API: The Good Partsを読みました。平易な日本語で書いてあるので、読みやすかったです。 とはいえ、何度も本を読み返すのは大変なので、自分用まとめも兼ねて書こうと思った次第です。 1個1個まとめていくと結構な量があるので今回は「レスポンスデータの設計」についてまとめました。 本でいうと3章に書いてあります。 この記事も参考に Web API: The Good Partsの他のまとめ記事もここに載せておきます。 2.2: Web API: The Good Partsを読んだので「良いURI」についてまとめた 2.6: Web API: The Good Partsを読んだので「OAuthの仕組み」についてまとめた 4章: Web API: The Good Partsを読んだので「HTTPの仕様」についてまとめた 5章: Web AP

ここ数年、Web API(以降API)を作る機会が増えています。例えば、スマホやシングルページアプリケーションのバックエンド,システム間のデータ連携などです。 これらのAPIを複数の言語やフレームワークで実装してみましたが、個々の機能を実装する前に考えるべき事は共通していました。これから先も多くのAPIを作成する事になると思いますので、APIを作る上での共通実装をまとめてみたいと思います。 目次 文字コード 日付書式 リクエストフォーマット レスポンスフォーマット API認証 Validation トランザクション ログ出力 横断処理 共通例外処理 設定ファイル 処理時間の計測 X-Request-ID ヘルスチェック 単体テスト デプロイ 検討項目 文字コード UTF-8を選択します。 日付書式 ISO8601形式を選択します。 曖昧さを無くすためタイムゾーン情報を付与したいためです。

Pushnate を使用して Web サイトにプッシュ通知 （Web Push notifications） を楽々導入する Web プッシュ通知に関する基本的な知識と、Web プッシュ通知配信サービス、Pushnate を使用して Web サイトにプッシュ通知を導入する手順についてまとめています。 Push API （Service Worker） を利用したプッシュ通知は、まだ正式版としてリリースされている対応ブラウザが Google Chrome （v.42 以降 / PC or Android） しかないため、現状では一般的ではありませんが、予定では本日正式版がリリースの Firefox 44 も Service Worker に対応したため、少しずつですが利用機会が増えそうな感じになってきました ※。 で、試しにこの Blog でもプッシュ通知を導入して、どんな感じになるのか実験

Visual Studio Codeの拡張機能（エクステンション）開発に使えるAPIはよく考えられたものが取り揃えてある（何様）。 vscode名前空間から呼べる関数や型だけに限るとそう大層なことはできない印象を抱くかもしれないけれど、拡張機能のマニフェストファイル(package.json)も合わせると色々なことができる。 また、APIとして公開されていないけれども、Visual Studio Codeにプリセットされている機能（タスク実行や拡張機能のインストールなど）は、コマンドとして呼べるようになっている。 今回は、そこのところを含めて、コマンド系のAPIを紹介したい。 vscode.commands vscode.commands名前空間に、コマンドの登録/取得/実行をするための関数が1packageになっている。 コマンドを登録する – registerCommand regis