WebAPIドキュメント作成サービス apiary.ioを使ってみた
apiary.ioを使ってみました。 WebAPI(REST API)のドキュメントをサクっと書けるサービスです。 http://apiary.io/ 去年(2012)年にローンチされたサービスで、何かに使いたいな〜と思いつつ...。 今回、開発中のWebサービスにWebAPIを実装することとなったので使わせていただいております。 (そのドキュメントはまだ公開してないです。すみません(汗;)) 以下のように、API Blueprintという簡単な文法で、 "リクエスト"と"レスポンス"の例を記述するだけで 便利なドキュメントができあがります。 HOST: http://api.example.com/ --- ほげほげ API v2 --- --- Welcome to our API. Comments support [Markdown](http://daringfireball.n
Platform API Reference | Heroku Dev Center
Overview The platform API empowers developers to automate, extend and combine Heroku with other services. You can use the platform API to programmatically create apps, provision add-ons and perform other tasks that could previously only be accomplished with the Heroku CLI or Dashboard. For details on getting started, see Getting Started with the Platform API. Authentication OAuth should be used to
HerokuのAPIデザイン
Herokuが自ら実践しているAPIデザインガイドをGithubに公開した． “HTTP API Design Guide” このガイドは些細なデザイン上の議論を避けて，ビジネスロジックに集中すること目的としている．Heroku特有なものではなく，一般にも十分適用できる知見となっている． 最近は，モバイル向けにAPIをつくることも多いため，勉強もかねて抄訳した．なお内容は，HTTP+JSONのAPIについて基本的な知識があることが前提となっている． 適切なステータスコードを返す それぞれのレスポンスは適切なHTTPステータスコード返すこと．例えば，“成功"を示すステータスコードは以下に従う． 200: GETやDELETE，PATCHリクエストが成功し，同時に処理が完了した場合 201: POSTリクエストが成功し，同時に処理が完了した場合 202: POSTやDELETE，PATCHリク
Apiary - r7kamura per second
API(とそれに携わる開発者)の規模が拡大してくると、ドキュメントの整備や、仕様と実装の一貫性の維持、 クライアントとの知識の共有など、考慮すべき問題が沢山出てくる。 これらの問題に対する現実的な解決策を探るため、 ApiaryというAPI開発支援用のサービスを簡単に俯瞰することにした。 ここでは紹介しないが、他に RAML、 JSON Schema、 Swagger、 WADL、 Autodoc などが関連するものとして挙げられる。 Apiary http://apiary.io/ Apiaryは、API Blueprintと呼ばれる言語でAPIのインターフェース仕様書を記述する、という開発方法を提唱している。 API BlueprintはMarkdownを拡張した言語で、特殊な記述を用いて幾つかのメタ情報を付与出来る形になっている。 Markdownを採用することで人間にとって読み書き
NHK 番組表 API を触る為の Ruby クライアント作った - Kōenji
NHK 番組表 API が公開されたので Ruby の API ライブラリを作った インストール 下記コマンドでインストール出来る gem install nhk_program 使い方 こんな感じで使える client = NHKProgram.new(api_key: 'YOUR_API_KEY') # 明日のNHK総合1の番組表取得 data = client.list('130', 'g1', Date.today + 1) # 違う書き方 # data = client.list('東京', 'ＮＨＫ総合１', :tomorrow) data.list.g1.each do |program| # 何かする end # 明日のNHK総合1のアニメの番組表取得 data = client.genre('130', 'g1', '0700', Date.today + 1) # 違う
Web API認証について
最近、Web APIの認証をどうすべきか考えている。 例えば次のようなケースをどうするか。 「既存のWebサイトがあり、既にユーザＩＤとパスワードによる認証によって、ブラウザでデータを提供している。 今回、この提供データをブラウザの画面ではなく、REST APIにて取得可能にしたい。 このデータはユーザ毎に取得可能な値が違うので、認証、または認可によって制限をかけたい。」 ユーザーがブラウザからIDとパスワード(以下ID/PW)を使ってログインする方式を、そのままWeb APIにも適用しても安全なのだろうか。 Web APIの先にはスマホアプリやシェルスクリプトなどから直接ログインするものなどが考えられるが、安全かつシンプルに実装するにはどうしたらいいのだろうか。 私はセキュリティの専門家ではないので間違った考え方をしている可能性もあるが、誰かの目に留まって助言いただけるかもしれないので、
Test-driving a Node.JS API
I have recently been working on a couple of full-stack JavaScript (MEAN) applications. One of the first projects did not have a well-tested API. Eventually, it turned out the data it returned was not always correct. This shows the importance of testing your APIs. The great news? Testing your Node.JS API is actually quite easy. In this post we will be building a simple RESTful JSON API through test
IPアドレスの地理的位置情報が引ける無料RESTful API集 | ゆっくりと…
IP アドレスからサーバーの地理的位置情報（Geolocation）を調べてくれるオンライン・サービスは、ちょっと検索すればすぐに見つかりますし、有料のサービスも山ほどあります。が、サーバーから任意の IP アドレスが引ける無料のサービスとなると、ちょっと時間をかけて検索しなければなりません。 今回は、海外からのコメント・スパムをブロックする WordPress プラグインを作りたくて、タイトルの様なサービスを調べてみました。 IP Geolocation の歴史も調べてみましたので、雑学系としてもご覧ください。 IP Geolocation の歴史 IP アドレスから ISP の位置情報を推定する技術は、1990年後半から研究されていました。DARPA がメインスポンサーの非営利団体 CAIDA（インターネット・インフラの発展のために、産学官が管理面・技術面で協力し合う非営利団体）が N
REST APIのテストする開発ツール Google Chrome「Postman」
iPhone, Androidアプリ向けにRest APIなWebサービスを開発している時にアプリを起動せず簡単にテストするツールを探したときの覚書。 参考 testing - What tools can I use to test a REST API? - Stack Overflow What tools do you use to test your public REST API? - Stack Overflow REST / HTTP API Tools for Development and Testing | Minimum Viable Pontification Google Chrome拡張機能「Postman - REST Client」 多機能でサクサク動くので使いやすい。 履歴機能など必要なものは揃っていて、ソースコードも公開されているので素敵すぎる。 Fi
Philips hue と API と JavaScript - ELAB.
この記事はFrontrend Advent Calendar 2013 3日目の記事です。 一年ぶりの更新ですね。月日が流れるのは早いものです。 以前から、ArduinoやらLeap Motionやら何やら、フィジカルコンピューティング的なものに興味だけはあるのですが、この度、Philips hueという素敵なアイテムを手に入れることができたので、それのアレコレについて。 Meet hue - Philips hue (https://www.meethue.com/ja-US) “Philips hue”はPhilips社から発売されている、照明システムです。 見た目はただの電球ですが、スマホ用のアプリ等から、ON/OFFはもちろんのこと、明るさ/色調の操作やタイマー設定とかジオロケーション連動とかできる優れもの電球です。 これに加えて、RESTfulなAPIも公開されていることが最も素
apiDoc - Inline Documentation for RESTful web APIs
apiDoc creates a documentation from API annotations in your source code. Java, JavaScript, PHP, … CoffeeScript Elixir Erlang Perl Python Ruby Lua /** * @api {get} /user/:id Request User information * @apiName GetUser * @apiGroup User * * @apiParam {Number} id Users unique ID. * * @apiSuccess {String} firstname Firstname of the User. * @apiSuccess {String} lastname Lastname of the User. */ ### @api
ブラウザが消滅して： APIベースのWeb - 檜山正幸のキマイラ飼育記 (はてなBlog)
「僕らが大好きだったWebはなくなるのかもしれない」において、「Webページ／Webサイトから構成される従来型のWebはなくなるのではないか」と述べました。 ここで、極端な想定として「Webブラウザが消滅してしまった」としましょう。これは、あくまで想定であって、未来予測をしているわけではありません。 汎用のブラウザに代わるのは、個別の機能を持ったアプリ群です。これらのアプリ（の多く）は、通信のインフラとしてインターネットを利用するので、インターネットはやはり必須で重要な存在です。 ブラウザがなければ、Webページから構成されるWebサイトは意味を持ちません。Webサイトはアプリのリモートバックエンドに置き換えられ、Webページはアプリの状態に取って代わられます。 アプリとそのリモートバックエンドは通信をするのでプロトコルが必要です。そのプロトコルは、HTTP（の発展形）がやはり主流でしょう
Python REST API Framework — Eve 0.4-dev documentation
Eve. The Simple Way to REST¶ Version 2.1.0. Eve is an open source Python REST API framework designed for human beings. It allows to effortlessly build and deploy highly customizable, fully featured RESTful Web Services. Eve is powered by Flask and Cerberus and it offers native support for MongoDB data stores. Support for SQL, Elasticsearch and Neo4js backends is provided by community extensions. T
Python REST API Framework: Eve, the Simple Way to REST. — Eve 2.1.0 documentation
Eve. The Simple Way to REST¶ Version 2.1.0. Eve is an open source Python REST API framework designed for human beings. It allows to effortlessly build and deploy highly customizable, fully featured RESTful Web Services. Eve is powered by Flask and Cerberus and it offers native support for MongoDB data stores. Support for SQL, Elasticsearch and Neo4js backends is provided by community extensions. T
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - interagent/http-api-design: HTTP API design guide extracted from work on the Heroku Platform API
通信プロトコルから見る艦隊これくしょん on 第十回 カーネル／VM探検隊
GitHub - mashery/iodocs: Interactive API documentation system
Welcome
http://flippinawesome.org/2013/09/23/easy-api-scaffolding-with-simple-api-and-node-js/
GitHub - nicolaiarocci/eve: REST API framework designed for human beings
