[B! document][autodoc] manabouのブックマーク

manabou id:manabou

documentとautodocに関するmanabouのブックマーク (2)

APIドキュメントを書くのが楽になるツールまとめ - Qiita
さいきん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 ·
manabou 2015/05/16
api

web

swagger

iodocs

autodoc

webapi

test

document
リンク
Autodoc - r7kamura blog
闇Advent Calendar 1日目の記事として、最近の開発における心の闇に触れます。最近開発した Autodoc というツールについて簡単に説明した後、この手のツールの開発にあたって考えていた、創作活動の在り方や、社会の斥力、25歳定年説などについて触れようと思います。 Autodocとは Rack applicationで実装されたAPIに対して、RSpecで書かれたテストを元にAPIドキュメントを生成するもの。テストを実行すると、テスト中に発行したリクエストやレスポンス、そのテストに付けられたメッセージを元に、良い感じに情報をまとめ、Markdown形式でAPIドキュメントを記したファイルを生成してくれる。例えばGitHubではMarkdownファイルを適当に描画してくれるので、下図のようにGitHub上で簡単にドキュメントを閲覧出来るようになる。テストの書き方
manabou 2015/05/16
api

ruby

rspec

document

autodoc

test

testing
リンク
1