API Blueprintを使ってAPI仕様書を作ってみました。

https://tech.excite.co.jp/entry/2022/02/28/140000

上記のプライベートカンファレンスでの登壇資料になります。

## プロポーサル
API設計及び仕様作成を求められることはあれど、今までスプレッドシートを使った雑なものしか作ったことがなかったのですが、
APIの仕様書をつくるのにはすこししんどいなと感じ始めていて、これを機にちゃんとしたツールを使いはじめようと思ったのがきっかけです。

APIの仕様書を作成するツールだと、swaggerなどもありますが、こちらはちょっと一日二日で飛びつくにはハードルが高いなと感じていたところ API Blueprintに行き着きました。
ほんとに半日もかからずすぐに馴染むことができて、今ではそれを便利に使って仕様書を作成しています。

私のようにノーツールのユーザがちょっと背伸びするには最適の言語でしたので、ぜひとも色んな方にその所感をご紹介できればと思います。

Transcript

1. API Blueprintを使って API仕様書を作ってみました。 Excite × iXIT TechCon 2022/02/18 岡村 啓二郎 Life & Communications事業部 L&Cシステム開発部/テクノロジー第1グループ
2. はじめに ・きっかけ ・API Blueprintの概要 ・API Blueprintの記述 ・API Blueprintで生成した仕様書 ・所感 2
3. きっかけ
4. はじめて自分で作ったAPI仕様書 4 Private
5. まさかのスプシ
6. はじめて自分で作ったAPI仕様書 6 名前 メソッド パス リクエスト レスポンス 詳細仕様 😩検索性サイアク 😩そもそもフォーマットとして適していない 😩ハイライト✕ 😩UI微妙 Private
7. 好奇心を起点にする。 専用のツールはないのかな？ 素直さとリスペクトで学ぶ。
8. https://apiblueprint.org/
9. WebAPI用の強力な高レベルAPI記述言語 ※mdをベースとしたmsonという拡張記述 API Blueprint の概要 9 aglio HTML
 MD

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

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