docs: add api spec

codeforjapan · Nov 1, 2024 · 35be03e · 35be03e
1 parent 5353596
commit 35be03e
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/example.md b/docs/example.md
@@ -1,5 +1,15 @@
 # BirdXplorer の 使用例
 
+## API仕様の閲覧
+
+API 仕様は、[Swagger UI](https://birdxplorer.onrender.com/docs) で閲覧できます。
+
+また、[OpenAPI Spec](https://birdxplorer.onrender.com/openapi.json) も提供しています。
+
+> [!TIP]
+> OpenAPI Specification から API リクエスト用のコードを生成するライブラリを使用することで、
+> API の入出力をコード上で安全に扱えることがあります。
+
 ## 特定のトピックのコミュニティノートと、そのトピックに関連するツイートを取得する
 
 BirdXplorer では、コミュニティノートのトピックを AI で推定して分類しています。