APIドキュメンテーションツールを使いこなす【Api Blueprint編】

API

イベント内容

D3とは

創業以来、高い技術力と戦略的なUI/UXを武器に、世の中に価値あるサービスを生み出しているビズリーチ。
サービスの数が増えるにつれ、技術の幅が広がったため、そのスキルやノウハウを社内のみならず、
世の中のエンジニアやデザイナーとも共有すべく、
私たちは「D3(ディーキューブ)※」というプロジェクトチームを立ち上げました。
D3では、たくさんのイベントや勉強会を開催し、
世のエンジニア・デザイナーと共に、さらなる高みを目指します。
※D3=DESIGNER & DEVELOPER DIVISION

イベント説明

みなさん、APIドキュメント書いてますか?

ドキュメントと聞くと抵抗を感じるエンジニアの方もいるかもしれません。
あるいは、APIドキュメントは必要と考えつつも「でも工数が...」「でもメンテが...」と嘆いている方もいるかもしれません。

そんな悩み多きAPIドキュメントを手軽に記述でき、さらに「生きた仕様書」として活用することができる素晴らしいツールがあります。

APIドキュメンテーションツールには幾つか候補がありますが、その中でも人気のある「Api Blueprint」について、その記法や便利な使い方、また、プロジェクトに導入してみた事例をお話ししたいと思います。

Api Blueprint: https://apiblueprint.org/

発表内容

  1. APIドキュメントの概要
  2. Api Blueprintの概要
  3. Api Blueprintの記法
  4. Api Blueprintを支える周辺ツール
  5. プロジェクトに導入してみたお話

対象

対象とする方

  • APIドキュメントの導入を考えている方
  • APIドキュメントの管理に疲れている方
  • APIドキュメンテーションツールに興味がある方

対象としない方

  • 既にApi Blueprintをバリバリで使いこなしている方 (公式のドキュメントに沿った記法紹介も行う予定のため、退屈になるかもしれません)
  • swaggerやRAML等の他のツールの話を聞きたい方 (今回はApi Blueprintにフォーカスを当てての内容とさせていただきます)

推奨知識

  • Markdown記法 (拡張Markdownを用いてのコードを紹介する予定のため、あるとわかりやすいです)

開催概要

  • 日時:2017/06/29(木)20:00〜21:00(19:45開場)
  • 場所:株式会社ビズリーチ 東京都渋谷区渋谷2-15-1 渋谷クロスタワー 12F
  • 参加費:無料
  • 持参物:名刺1枚(名札用)

登壇予定者

  • スタンバイ事業部 エンジニア
    権藤尚樹

アジェンダ

時間 発表者
19:45~20:00 受付
20:00~21:00 イベント


※アジェンダは予告なく変更される場合がございます。

注意

  • イベント参加者によるスカウト等勧誘行為は禁止です。
  • イベントの写真を撮らせて頂く場合がございます。
  • イベントキャンセルが多い方はこちらで参加をお断りさせていただく場合がございます。
  • 参加登録時に入力していただいた名前・メールアドレスは今後ビズリーチのイベント開催等おしらせに利用させていただきます。 ご理解ご協力のほど、よろしくお願い致します。

注意事項

※ こちらのイベント情報は、外部サイトから取得した情報を掲載しています。
※ 掲載タイミングや更新頻度によっては、情報提供元ページの内容と差異が発生しますので予めご了承ください。
※ 最新情報の確認や参加申込手続き、イベントに関するお問い合わせ等は情報提供元ページにてお願いします。