Tweet
Tweet

Slide 1

Slide 1 text

API Blueprintを使って API仕様書を作ってみました。 Excite × iXIT TechCon 2022/02/18 岡村 啓二郎 Life & Communications事業部 L&Cシステム開発部/テクノロジー第1グループ

Slide 2

Slide 2 text

はじめに ・きっかけ ・API Blueprintの概要 ・API Blueprintの記述 ・API Blueprintで生成した仕様書 ・所感 2

Slide 3

Slide 3 text

きっかけ

Slide 4

Slide 4 text

はじめて自分で作ったAPI仕様書 4 Private

Slide 5

Slide 5 text

まさかのスプシ

Slide 6

Slide 6 text

はじめて自分で作ったAPI仕様書 6 名前 メソッド パス リクエスト レスポンス 詳細仕様 😩検索性サイアク 😩そもそもフォーマットとして適していない 😩ハイライト✕ 😩UI微妙 Private

Slide 7

Slide 7 text

好奇心を起点にする。 専用のツールはないのかな？ 素直さとリスペクトで学ぶ。

Slide 8

Slide 8 text

https://apiblueprint.org/

Slide 9

Slide 9 text

WebAPI用の強力な高レベルAPI記述言語 ※mdをベースとしたmsonという拡張記述 API Blueprint の概要 9 aglio HTML
 MD


Slide 10

Slide 10 text

元となるmdファイル 10 hoge.md リクエスト レスポンス レスポンス 仕様 パス メソッド ヘッダー 名前

Slide 11

Slide 11 text

aglio -i hoge.md -o hoge.html


Slide 12

Slide 12 text

12 完成😉

Slide 13

Slide 13 text

13 リクエスト

Slide 14

Slide 14 text

14 レスポンス

Slide 15

Slide 15 text

良かったこと ・必要十分な機能が用意されている ・デザインや見栄えを意識しなくていい ・導入手順がラク、学習コストもほとんどナシ 　0知識の状態から、数時間でマスターできました😉 15

Slide 16

Slide 16 text

https://apiblueprint.org/