WebAPIでエラーをどう表現すべき？15のサービスを調査してみた - Qiita
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を設計してみるとどんなインターフェイスがいいのか、どんな形式がいいのかといった疑問が次々と出てきます。
報道発表資料 : 「デバイスWebAPIコンソーシアム」を設立 | お知らせ | NTTドコモ
お客様の設定により、お客様情報が「非表示」となっております。お客様情報を表示するにはdアカウントでログインしてください。 お客様情報表示についてへ お客様情報表示についてへ 報道発表資料 「デバイスWebAPIコンソーシアム」を設立 ＜2015年4月30日＞ 株式会社NTTドコモ ソフトバンクモバイル株式会社 株式会社NTTドコモ、ソフトバンクモバイル株式会社は、複数のウェアラブル機器やIoT機器を一元的に操作するスマートフォンアプリやWebアプリの開発を容易にするインターフェース技術「GotAPI」※1 について、普及活動や機能検討を行う「デバイスWebAPIコンソーシアム」を本日設立いたします。 「GotAPI」は、ドコモが開発した「デバイスコネクトWebAPI」をベースに、2015年4月16日（木曜）にOMA※2 にて標準化されたインターフェース技術で、「GotAPI」をインストール
APIドキュメントを生成するためのMarkdown拡張API BluePrintとその周辺のライブラリ - Qiita
API Blueprint(以下Blueprint) は MarkdownファイルからAPIドキュメントやサンプルデータになる JSONを生成する仕様。 一旦決められたフォーマットのJSONに吐き出すので、 それを中心に入出力のライブラリが色々あったりする。 Blueprintのパーサー MarkdownからJSONを出力するために Snow Crashというライブラリを利用する。 後に書くものは大体このSow Crashを利用するので詳細は省略。 BlueprintからAPIドキュメントHTMLを生成する Blueprintを上手く扱うために、 色々なライブラリが用意されている。 aglioはBlueprintから表示用htmlを用意してくれるライブラリ。 # output.htmlにファイル出力 $ aglio -i input.md -o output.html # デフォルトの h
API Blueprintとgulp-aglioでいい感じのAPIドキュメントページを作成 - はてなブログ
きっかけ 現在関わっているWebサービスの各種APIをまとめたドキュメントを作りたかった いい感じのHTMLページにして、なるべく簡単に作りたかった Web上のサービスではなくローカルで作りたかった やったこと APIドキュメントの作成は以下の手順で行いました。 1. gulp-aglioをインストール gulp-aglioはAPI Blueprint(後述)で書かれたMarkdownをHTMLにパースするgulpプラグインです。 自分がmacにインストールした手順は以下の通りです。 (1) nodeをインストール Homebrewを使ってnodeをインストールします。 brew install node (2) gulpをグローバルインストール npmでgulpをグローバルインストールします。 npm install -g gulp また、インストールは以下のコマンドで確認します。 gu
APIの仕様をMarkdownで定義する - HDE BLOG
おはこんばんちは!! 尾藤 a.k.a. BTO です。 Web APIの仕様の定義ってみなさんどうされているでしょうか。 人によって書き方がバラバラだったり、定義に過不足があったりしてないでしょうか。 Web APIのインターフェースで定義する内容は、ほとんど決まってます。 もっと形式的な書き方できないだろうかと探してみたら、やはり同じ事を考えている人がいて、API Blueprintというのを見つけました。 API Blueprint - API Documentation with powerful tooling API Blueprintを使うとMarkdownでAPIの定義ができます。 できること APIの記述フォーマットが決まっていますので、どこで何が定義されているかが分かります。 ですので、機械的に処理する事ができるようになります。 具体的には、 APIドキュメントの生成
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
APIドキュメントをAPI Blueprintで書いてaglioで出力したいときにLiveReloadしながら書くためのgulpfile.coffee - Qiita
WEB APIのURL設計のトレンドはこれだ！WEB APIのURL設計まとめ