成果物：apiary.ioによる、APIドキュメント とりあえず見て貰えるとイメージつかみやすいです↑ あらすじ 100万円欲しいのでAPIを利用したアプリ開発を学ぶ絶好の機会なので、東京メトロオープンデータ活用コンテストに挑戦しようとしている。 前回、とりあえずざっと触ってみてAPIのイメージは掴んだ 今回は、公式ドキュメントと実際のレスポンスを咀嚼して、仕様設計を汎用ドキュメント化しつつ理解していくことを目的とする せっかくドキュメント化するからには、汎用性と実用性が高いフォーマットとしたい（オレオレにはしたくない） 成果物 API Blueprintで記述されたテキストをApiary.ioでホスティングし、以下を作った TokyoMetroOpendataAPI · Apiary github上のソース（markdownプレビュー版） やってみてわかった、ApiaryによるAPIドキ
もし急にAPIドキュメントを書く必要が発生したら、何を参考にしたら良いのか。REST APIを提供しているサービスがどういった開発者向けドキュメントを提供しているのかについて調べた。今回対象としたサービスは、GitHub、Twitter、Square、DigitalOceanの4つのサービス。 https://developer.github.com/v3/ https://dev.twitter.com/docs https://developers.digitalocean.com/ https://connect.squareup.com/docs/api なお以下の文章の中では、個々のアクセス可能なメソッドとURLの組み合わせを指して「API」という言葉を使うことがある。例えば、GET /gists/:id という特定の投稿を取得するAPIや GET /gists/:gist_id
さいきんREST APIのドキュメントを書いていて、wiki使うのだるいし他に良い方法ないかな〜と調べてた時に見つけたツール群をまとめてみます。 追記: こちらも便利そうなので参考にどうぞ。 REST APIドキュメント作成ツールはapiary.ioが決定版かもしれない - Qiita swagger Swagger: A simple, open standard for describing REST APIs with JSON | Reverb for Developers デモ: Swagger UI ソースコード中にAPIの概要を書いておくと、それを元にドキュメントを自動生成してくれる。wikiやmarkdownで書くのと決定的な違いは、↓のようにドキュメント上のformからAPIコールを試すことができる点。 様々な言語のWAFに対応したライブラリも開発されてる。 Home ·
wikiとかでドキュメントを書くのが面倒で、良いツールを探していたらiodocsというnode製ツールを見つけた。 これを使うとドキュメント作成が楽になるだけじゃなく、 ドキュメント上のformからAPIリクエストを試せて便利っぽい。 普段APIドキュメントを見つつcurlとかでリクエスト送信して試してたのが、全てドキュメント上で完結して良さげ。 使い方 mashery/iodocsからcloneしてアプリを起動すると、FoursquareやLinkedin APIを叩くサンプルをすぐに試せる。redisが必要なのでserver起動を忘れずに。 ~/ $ git clone http://github.com/mashery/iodocs.git ~/iodocs $ npm install ~/iodocs $ redis-server & ~/iodocs $ npm start {
Swagger places API specifications such as OpenAPI, AsyncAPI, and JSON Schema at the core of its architecture, which are crucial for guiding teams through the entire lifecycle of API design and documentation. This strategic focus ensures that our suite, including open source tools and API Hub, delivers unparalleled efficiency and a seamless user experience. Explore the API Specifications Discover t
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
API(とそれに携わる開発者)の規模が拡大してくると、ドキュメントの整備や、仕様と実装の一貫性の維持、 クライアントとの知識の共有など、考慮すべき問題が沢山出てくる。 これらの問題に対する現実的な解決策を探るため、 ApiaryというAPI開発支援用のサービスを簡単に俯瞰することにした。 ここでは紹介しないが、他に RAML、 JSON Schema、 Swagger、 WADL、 Autodoc などが関連するものとして挙げられる。 Apiary http://apiary.io/ Apiaryは、API Blueprintと呼ばれる言語でAPIのインターフェース仕様書を記述する、という開発方法を提唱している。 API BlueprintはMarkdownを拡張した言語で、特殊な記述を用いて幾つかのメタ情報を付与出来る形になっている。 Markdownを採用することで人間にとって読み書き
背景 APIドキュメントを書くのが楽になるツールまとめ - Qiita iodocsで便利なREST APIドキュメントを作成する - Qiita これまでずっとREST APIドキュメントをwiki上で管理していて、重たいページ上で特殊記法使ったり、スタイルの調整に時間を取られるのが辛かった。そこで良さげなドキュメントツールを色々調べてたんだけど、最終的にapiary.ioが一番良さそうという結論になってきた。 このサービスの主な特徴。 markdown記法でAPIドキュメントを記述できる ドキュメントの生成と同時にAPIのモックサーバを用意してくれる サインアップから5分くらいあればドキュメント公開できる。ドキュメントのホスト先を気にしなくてもいい。 特にドキュメントと一緒にモックを作ってくれるのは他にはないポイントでかなり便利。 使ってみる サインアップはGithubアカウントで h
本日は趣向を変えて複数の計算機を透過的にひとつのものとして使う話です。以前にデータ分析用の計算機環境を用意する話をしましたが、その続きというか補足です。 手元の計算機で開発する問題点 人によっては手元のノート PC の性能にこだわり、ローカルで開発をしたりする人がいるようですが、この場合いくつかの問題があります。 いくら性能の高い計算機を買おうとも、その性能には上限がある 長時間かかるジョブを実行した場合、終了するまでノートを閉じて持ち運んだりできない 複数の拠点で開発する場合、重いノートを持ち歩かなければならない 手元の計算機に障害が発生するとすぐに開発の継続が困難になる ソリューション これに対し、遠隔に設置したものも含む複数の計算機によるクラスタで開発をする場合、さまざまなメリットがあります。 スケールアウトすることができる 長時間かかるジョブを実行し、そのまま接続を切り離せる 複数
REST API用のドキュメントを生成するときにどうやってるかについて雑記を残しとく。 概要 実装とドキュメントの乖離を避けるためには、同じ意味情報を二箇所以上に定義することを避ける必要がある。そのための方法として、実装それ自身か、もしくは実装が参照している何らかのメタデータを元にしてドキュメントを生成したり、テストの実行結果からドキュメントを生成するというパターンがある。 テストから Cookpadでは、autodocというライブラリを利用して、RSpecでテストを実行している途中で得られたメタデータからドキュメントを生成している。これはテストの実行結果からドキュメントを生成するパターン。 これは実現方法としてはかなり特殊な部類。このパターンが最も効果的に働くのは、ドキュメント生成のために余分な開発コストはあまり掛けたくないが、テストは真面目に書いている OR 真面目に書いてほしい、とい
gearedの編集部員たち。各自各様のサブカルチャーを愛するが、比較的共通している趣味は音楽、ラーメン、東海林さだお。 この Sitpack は「もっともコンパクトに畳める」とアピールされているモバイルチェア。細長いコーヒータンブラーを思わせるサイズ&形状のボディをパカッと開き、スライド式の足をスルスルと引っ張りだすと、立った姿勢で腰掛ける一本足の椅子になるのです。 収納時のサイズは、直径6.6cmで高さが16.8cm。ズボンのポケットにも入りそう。足は87cmまで伸ばすことができ、耐荷重量は130kgです。 メーカーが提案している用途は、スポーツや野外ライヴの観覧、釣りやバードウォッチング、飛行機の待ち時間など。とにかくコンパクトなので、どんな場所にも持って行けるし、これ以外にもさまざまな使い方が考えられるでしょう。とりわけ、キャンプなどアウトドアのアクティビティで重宝しそうです。 Si
マイクロソフトは、C++でいかにしてMicrosoft Officeのクロスプラットフォームを実現したのか マイクロソフトはOfficeソフトウェアのマルチプラットフォーム展開を進め、Windows版、Macintosh版だけでなくWebから使えるOffice Onlineに加え、iPad版、Android版も公開を始めました。 Officeのような大規模なアプリケーションのマルチプラットフォームへの移植は、どのようにして行われているのか。9月に米国で開催されたC++言語のイベント「CppCon 2014」で行われた同社の講演「How Microsoft Uses C++ to Deliver Office (and More) Across iOS, Android, Windows, and Mac, Part I 」がYouTubeで公開されています。 Officeのコア部分はC++
Japanese psych punk quartet Bo Ningen choose a selection of the most out-there cosmic rock tunes from the land of the rising sun. The four members of psych punk band Bo Ningen come from all across Japan, but they originally met in London, where they now reside. Taigen and Kohhei formed the …Read more
先日 Cycling’74 Max7 勉強会（のβテスト開催）をDMM.make AKIBAの一角を間借りして開催しました。ちなみに急遽開催だったため、お呼び出来なかった方すみません。参加者は左から→@CO_CO_ / @ishicca / TY0004 / @raykunimoto / @nanagagatata + @mirrorboy 勉強会の内容 半日かけてMax7の新機能を中心に、各々が気になる機能を好き勝手触るという無謀なやり方でしたが、結果的には皆で新機能に関する知見が共有できました。 参加者の中ではBEAPとVIZZIEの扱いやすさが特に人気でした。サウンド・アートなどをされている神谷氏（@ishicca）。最近はデジタルを使わない作品が多いため、Maxを弄るのは久しぶりだったとのこと。 チュートリアルをやるMaxレッスンの生徒さん。右側で実演される動画に合わせて、左側で実
2020/12/27追記 https://www.ruby-lang.org/ja/news/2020/12/25/ruby-3-0-0-released/ => Ruby3.0.0にRBSとTypeProfと用いた静的解析に対するソリューションが提供されました。 今後はこちらのエコシステムをガンガン盛り上げていきましょう💪 #あいさつ P.S. 12/11 HaskellからRubypeにgemを変更しました こんにちは. 寒さが一段と厳しくなってきた事もありまして心を温めるGemを作りました. Rubyの振る舞いを汚染する事無く型保証の恩恵をゆるふわ受けられるgemです （型をつけるとか型保証という言葉をこの文脈ではメソッドの引数返り値のクラスを実行時にチェックするという意味で使っている.） 得体の知れないGemで抵抗感があるかもしれませんが、コード自体は50行以下の薄いGemなので
A quick and easy pre-configured Emacs for developing with Haskell. You can use this to try out the Emacs support for Haskell, or use it as a base or to crib Elisp from, or whatever. The motivating use-case is that newbies tend to want something that just works that they can customize later. This aims to be that repo. At least, an opinionated version of it. Most of it is using my tooling, so it's v
この記事はPHP Advent Calendar 2014の7日目です。 僕は先日のPHPカンファレンス2014でPHP7に関するLTをしました（参照：「PHPNGの動向」）。ただ、時間が限られていたこともあり、あまり踏み込んだ内容には触れませんでした。 本稿ではLTの内容から深掘りし、zvalという内部的な構造体がどう変わるのか、性能面のメリットにフォーカスして解説してみます。 PHPをとりまく状況 まず最近のPHPの話題をおさらいしておきましょう。 これまでPHPには実用レベルの別実装が存在しない状態が続いていましたが、HHVMの登場で状況が変わってきました。HHVMはFacebookが開発しているPHP実行環境で、PHPより高速で互換性も高いのが特徴です。Facebookで実際に利用されているだけでなく、他の企業でも商用サービスで利用する事例が増えてきています。 そんな中、2014年
はじめに 皆様どうも。普段クライアントワークでアプリ開発をしている@ryusukefudaことデニールです。 突然ですが、日報書いてますか？毎日書くのは結構大変ですよね... ということでアドベントカレンダー５日目は新しい日報を考えて実装した話です。 やりたいこと 日報の趣旨はいろいろありますが、"何をしてたか" と "心身共に元気か" が見る人に分かればいいんじゃないでしょうか。 ということでこの2点に絞りました。 ちょっと考えた結果、 何をしてたか → 定期的にPCのスクリーンショットを撮る 心身共に元気か → 定期的にPCのウェブカメラで顔を撮る となりました。(仕事仲間なら顔をみれば何でも分かるはずです。) つまり、１日に何回か画面のスクショとその時の顔を取ってそれを日報として見てもらえば"何をしてたか"と"心身共に元気か" が分かるというものです！ 実装 Macのウェブカメラをコ
前置き 新しいelecribeを使って思ったことを箇条書きしてみました。 とりあえず自分について言うと、PCに向かってじっくりコツコツ打ち込みをするタイプなので、「ハードを同期で連ねてリアルタイムに組んでいく」派からはちょっと遠いんですが、そういう目線での印象と思って聞いてください。 ElectribeシリーズはMX-1だけ持ってて、2年くらい単機ライブしてました。他の旧エレクトライブはちょっと触ったかどうかってくらい。 優先度としては楽しく曲が作れればよいです。音色への言及は少なめ。 あと「elektronとくらべて～」みたいな比較レビューも詳しくないからできません。 わかりやすいとこ（「ポリフォニック対応！」とか「フィルターの種類が色々！」とか）は省略します。 （だいたいSystem Ver. 1.03 時点で書いた記事です） 好きな点 前機種（EMX）と比べ良くなった点、風評で覚悟し
リクエスト予約希望条件をお店に申し込み、お店からの確定の連絡をもって、予約が成立します。 1 予約の申し込み ご希望の条件を当サイトよりご入力ください。 2 お店からのメール ご予約が承れるか、お店からの返信メールが届きます。 3 お店へ来店 予約が確定した場合、そのままお店へお越しください。
Our creative director Michael Renaud picks out 20 of the most visually striking record covers of the year featuring: a twisted FKA twigs, creepy baby heads, creepier plushies, St. Vincent's all-seeing overlord, bloody guts, and a Waka Flocka mask. Visually speaking, musicians are now being pushed to find untraditional entry points into their work, such as interactive online experiences, apps, and
リクエスト予約希望条件をお店に申し込み、お店からの確定の連絡をもって、予約が成立します。 1 予約の申し込み ご希望の条件を当サイトよりご入力ください。 2 お店からのメール ご予約が承れるか、お店からの返信メールが届きます。 3 お店へ来店 予約が確定した場合、そのままお店へお越しください。
こんにちは、和田 (@t_wada) です。本日は Node.js Advent Calendar の 7 日目として、 Node.js で開発する際の設定ファイル package.json にまつわる Tips について書きたいと思います。 はじめに 私はこれまで power-assert を筆頭に、いくつか npm モジュールをリリースしてきました。 Node.js を使った開発には、設定ファイル package.json の記述が必要です。特に npm モジュールを公開する場合には、設定すべき事、考えるべき事もいろいろ増えてきます。今回は、 npm モジュールを作ってきた過程で学んだ package.json に関する Tips の中で、あまり知られていないマイナー気味なものを挙げていきたいと思います。 Tips1: package.json の files フィールドでホワイトリス
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
