Registration info |
参加枠1 Free
Standard (Lottery Finished)
|
---|
Description
概要
Wantedlyが内部向けにやっている勉強会に15名様だけご招待。
APIのドキュメントをどうするか、なかなか頭の痛い問題ですよね。JSON Schema, Swaggerもいいですが、今回はAPI Blueprintを紹介します。 WantedlyはMicroservice化を進めるにあたり、言語に依存せずに、APIドキュメントがとそれの整合性を保つためのテストが書けるAPIフレームワークを探していました。その中で一番良さそうとなったのが、Markdown形式でドキュメントを書いていく、API Blueprintです。API Blueprintは、apiaryという一つの会社がしっかりやっていることもあり、テストやエディタなど生態系が他のものよりも速いスピードで整ってきている印象があります。今回はこのAPI Blueprintの基本的な書き方、ドキュメント生成、テスト生成を行い、時間に余裕があればRailsのscaffoldのタイミングでAPI Blueprintの雛形を作ってくれるgemの紹介をします。
対象
- APIドキュメントを書く事に苦労をした経験のあるWeb, Mobileエンジニア
この速習会でできるようになること
- APIドキュメントを書く選択肢としてAPI Blueprintを使えるようになる
- API Blueprintを元にしたテストを行えるようになる
参加要件
- 最新のnode, railsをインストールしたPCを持参でいること
- nodeは
npm install aglio dredd api-mock
ができればOK - railsは
rails new hoge --api
が使えればOK
- nodeは
事前準備
Sync(グループチャットサービス)で質問受付るので事前ログインお願いします https://sync.wantedly.com/s/1Wi7YDj
懇親会
- 速習会のあと、軽食をご用意してあります。
Presenter
Media View all Media
If you add event media, up to 3 items will be shown here.