タグ

2017年5月16日のブックマーク (5件)

  • SwaggerでRESTful APIの管理を楽にする - Qiita

    背景 最近は変化し続ける要件に対応するために、システムも柔軟であることが求められています。 そのため、部分的に変更やスケールの可能なシステムを構築し、API経由で連携するマイクロサービス的アーキテクチャが増えてきています。 そういった設計の中で問題になっていくのが、従来のモノリシックなアプリケーションではIDEやコンパイラなどで行っていた、機能間のインターフェイスをどう管理するかという部分です。 Swaggerとは? SwaggerとはRESTful APIのドキュメントや、サーバ、クライアントコード、エディタ、またそれらを扱うための仕様などを提供するフレームワークです。 公式サイトでは、The World's Most Popular Framework for APIsと謳っています。 その理由は、マイクロソフト、Google、IBM、SmartBearなどを大手の企業を含む「Open

    SwaggerでRESTful APIの管理を楽にする - Qiita
  • API Blueprintによるドキュメント開発環境【2016年冬】 - dackdive's blog

    ここから少しアップデートしたのでメモ。 リポジトリ 特徴 markdown -> html への変換には aglio、ローカルサーバーは --server オプションを使う ローカルで markdown ファイルを html に変換するのに aglio を使うところは以前と同じ。 改めて調べてみると、--server というオプションでライブリロード機能つきのローカルサーバーの起動までやってくれるらしく、browserSync は不要だった。 また、ポート番号については README に記載されていないが、-p オプションで指定できた。 参考:Support for different port? · Issue #12 · danielgtaylor/aglio $ ./node_modules/aglio/bin/aglio.js Usage: node_modules/aglio/b

    API Blueprintによるドキュメント開発環境【2016年冬】 - dackdive's blog
  • APIのモックを簡単に作成できる「node-easymock」 - 大学生からの Web 開発

    フロントエンド・バックエンドを分離してAPI主体で開発していく「APIファースト」がホットっぽいですね。 http://wazanova.jp/items/698 それに捗りそうな「node-easymock」を紹介します。 何をしてくれるか 例えば、localhost:3000/userにアクセスしたら { "name": "taro", "age": 22, "comment": "Hi" } みたいなJSONを返してほしいなー、ってのをちゃっちゃと作れるツールです。 API実装はしてないけど、テスト用に使うためのモックサーバーを簡単に立てられるツール。 インストール node.js製でnpmを使ってインストールします。 $ npm install -g easymock 使おう localhost:3000/userから取得したければ、user_get.jsonに色々書いていきます。

    APIのモックを簡単に作成できる「node-easymock」 - 大学生からの Web 開発
  • HTTPステータスコードを適切に選ぶためのフローチャート : 難しく考えるのをやめよう | POSTD

    HTTPステータスコードを返すというのはとても単純なことです。ページがレンダリングできた?よし、それなら 200 を返しましょう。ページが存在しない?それなら 404 です。他のページにユーザをリダイレクトしたい? 302 、あるいは 301 かもしれません。 I like to imagine that HTTP status codes are like CB 10 codes. "Breaker breaker, this is White Chocolate Thunder. We've got a 200 OK here." — Aaron Patterson (@tenderlove) 2015, 10月 7 訳:HTTPのステータスコードのことは、市民ラジオの10コードみたいなものだと考えるのが好きです。「ブレーカー、ブレーカー、こちらホワイト・チョコレート・サンダー。200

    HTTPステータスコードを適切に選ぶためのフローチャート : 難しく考えるのをやめよう | POSTD
  • 【API Blueprintの使い方】Web APIの仕様書を書く・読む・実行する | DevelopersIO

    API Blueprintの使い方】Web APIの仕様書を書く・読む・実行する できればドキュメント書きたくないなー。はやくAPI実装したい!俺の頭の中に全部仕様入ってるから!俺が仕様だ! ... その仕様、API Blueprintでドキュメントにおこしませんか? はじめに デバイスが多様化し、その違いを吸収する統一的なインターフェースが求められる昨今、Web APIはその回答のひとつといえます。弊社でも、モバイルアプリとWeb APIを組み合わせてサービスを構築することがあります。 Web APIが登場する開発では、モバイルアプリ(APIクライアント)メンバーと、APIサーバメンバーのコミュニケーションが不可欠です。開発を円滑に進めるために、APIの仕様書 が必要になります。お互いがAPIの仕様を想像して勝手に開発を進めたのでは、いざ結合したときに悲惨な結果になることが目に見えてい

    【API Blueprintの使い方】Web APIの仕様書を書く・読む・実行する | DevelopersIO