はじめに
お久しぶりです。
前職の弁護士ドットコムを退社して、フリーランスとして働き始めたナミザトです。
最近コードを書くより、DX改善や設計、その他ドキュメントを書くことがほとんどになってきて、その都度、ツール毎にドキュメントを書くのめんどくさいなーと思うようになりました。
そこでNotionにあらかじめテンプレートを用意しておけば、最初から作る必要もないなーと思いテンプレートを作成しました。
概要
いま用意しているテンプレート
- APIルール
- API定義書
- PHPコーディングルール
今後用意していきたいテンプレート
- ERD
- PHPツール関連のハウトゥ
- 質問テンプレート
Notion テンプレート
API定義書の使い方
まずは自分のNotionに複製します。
そして API定義書 を開いてください。
機能毎に格納する親要素とその子要素にエンドポイントを用意しています。
詳細を見てみると、このようにAPIのサンプルが入力されています。
自分で新たに作成する場合は、HTTPメソッド毎にテンプレートを用意しているので、新たに作成してください。
おわり