Slate - Web APIのドキュメントを書く際にどうぞ！ MOONGIFT
Webサービスを提供していたり、スマートフォンアプリと連携するサーバを開発していたりすると必要になるのがWeb APIのドキュメントです。HTTPメソッド、パラメータ、返却値などが分かりやすく書かれている必要があります。 どういったドキュメントが読みやすいかは悩みどころですが、Slateは3ペインの構成になっていて見やすいのではないかと思います。ぜひご覧ください。 Slateの使い方 こちらがデモです。左が機能の一覧、中央が説明、右が実際のコードになります。 コードはShell、Ruby、Pythonで書かれています。 エラー時の内容も細かく書かれています。 Slateは一つのMarkdownファイルから生成されています。そのため単純なHTMLとして可読可能で、それをSlateを使って3ペインのより可読性高い形式にした訳です。Markdownで書く際に予めSlateの記法に沿って書いておく
《REST思想》と《リソース指向》と《Webページ》に関する（主にRailsの）話 - Qiita
これはいわゆるWeb APIについて、ということかなと推測しました。RESTというのはAPIのプロトコルのことだと思われている傾向がありますが、そういうわけではありません。Web全体についてのもので、APIについてもWebアプリについても適用されるものです。 実はRESTでは「統一インターフェイス」の制約からメソッドについて規定されていますが、URLの形については特に規定されません（もちろんAddressabilityの面で重要であることは言うまでもありません）。なので実は/books,/books/1でなくてもいいのですが、これを規約(CoC)でズバッときれいに決めてしまったのがRailsのすごいところの1つです。 本の追加や削除を行う場合は、本情報をJSON形式でPOSTリクエストのボディとして送ります。application/x-www-form-urlencoded形式で送ることは
Review: Vimeo API Update Provides Robust Access to Service's Ecosystem | ProgrammableWeb
Unleash the power of Salesforce Customer 360 through integration Read more
detectFace(); - 顔検出Webサービス
2018.04.04 detectFace();SDKの提供を終了しました。 2015.02.09 ポストされたjpeg画像にexifのorientation情報が付いている場合、 APIがそれを解釈するようになりました。 (Flash製サンプルでは事前の処理でexif情報が削除されてしまうため、 APIはorientationを認識できません) 2011.06.12 APIに若干の機能追加を行いました。 既存のクライアントとは完全な互換性があります。 入力画像の傾向に応じて検出モードを選択できるようになりました。 詳細はリファレンスを参照して下さい。 サンプルコンテンツ「簡易サンプル」を、 APIの新しい機能を使うように変更しました。 2010.08.26 APIに若干の機能追加を行いました。 既存のクライアントとは完全な互換性があります。 特徴点毎に信頼度が付加されるようになりました。
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
