SwaggerやPostmanでのAPIテストはすべて終わっているのに、肝心のドキュメントはNotionに別で手入力するのが繰り返しで非効率だと感じて作りました。
何を作ったのか: Swagger/OpenAPI(.json, .yaml)、Postman Collection(.json)、
Insomnia Export(.json) のどのファイルをアップロードしても、エンドポイント/パラメータ/リクエスト・レスポンス
例が整理されたMarkdownドキュメントに自動変換してくれます。そのままコピーしてNotionに貼り付けるか、
.mdファイルとして受け取ってリポジトリに入れればOKです。
どうやって試せるか: 上のリンクにアクセスするとすぐアップロード画面が表示され、手元に
ファイルがなくても画面にフォーマット別のサンプルファイルボタンがあるので、クリック一つでそのまま
結果を確認できます。
どんな点が特徴か: Swaggerだけをサポートする似たツールは見かけましたが、Postman/Insomniaの
exportファイルまであわせてパースし、統一フォーマットに変換してくれるものは見つけにくかったので、この点を
差別化ポイントにしました。ファイル内容を見てどのフォーマットか自動判別します。
まだログイン機能はなく、Insomniaはレスポンス例までは取得できないなど、初期MVP
段階です。実際に使ってみて不便な点や、このフォーマットにも対応してほしいという意見が
あれば、気軽にコメントしてください。
なぜ作ることになったのかをもう少し詳しく書いた文章はこちらに置いておきます:
https://velog.io/@dkslasdud/…
まだコメントはありません。