feat: add openAPI

[yamashita-kenngo]

目的

このPull Requestの目的を記載します。

Zod OpenAPIを追加する

https://hono.dev/snippets/zod-openapi

方法

目的を達成するためにこのPull Requestで実施した内容を記載します。

例）Backendに新たなAPIエンドポイントを追加しデータを取得できるようにした。

検証

このPull Requestで実施した内容を検証する方法を記載します。

例）新たに追加したAPIエンドポイントにリクエストを送り、データが取得できることを確認した。

✅チェックリスト

• [] このPRのユーザーへの影響範囲が明確である。例）ユーザーXがY機能を使えるようになる。
• [] このPRで実施した内容が明確である。例）新たなAPIエンドポイントを追加した。
• [] このPRで実施した内容を検証する方法が明確である。例）新たに追加したAPIエンドポイントにリクエストを送り、データが取得できることを確認した。
• [] このPRで実施した内容が正常に動作することを確認した。
• [] このPRで実施した内容が正常に動作することを確認するための自動テストが追加されている。注）自動テストがふさわしくない場合には、その理由を記載する。
• [] 一部ユーザーに影響を及ぼす場合、そのユーザーに通知するための手段が明確である。例）ユーザーXにメールで通知する。
• [] feature flagが設定されている。注）feature flagが必要な場合には、その理由を記載する。

Summary by CodeRabbit

• 新機能

  • OpenAPIを活用したAPIドキュメントの設定とルートハンドリングを更新しました。
  • ルート定義を追加し、新しいGETリクエストのルートパス/でJSONレスポンスを返すようにしました。

• 依存関係の更新

  • 新しい依存関係@hono/zod-openapi、zodを追加し、honoを最新バージョンに更新しました。

[coderabbitai]

概要

このアップデートでは、@hono/zod-openapiとzodの新しい依存関係が追加され、honoが更新されました。また、OpenAPIHonoを使用してルート処理とAPIドキュメントの設定が改善され、新しいルート定義ファイルsrc/router.tsが導入されました。

変更点

ファイル	変更概要
package.json	新しい依存関係@hono/zod-openapiとzodを追加し、honoを更新。
src/index.ts	HonoからOpenAPIHonoへの変更、ルートハンドリングとAPIドキュメント設定の更新。
src/router.ts	新しいファイルで、ルート/に対するGETリクエストの定義を追加。

詩

🐰✨
新しい依存関係、新しい道、
コードの森を跳ねる小さなうさぎ。
文書は光り、APIは清らか、
変更を祝って、パーティを始めよう！
🎉📄

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between db718e4 and c4c9062.

Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

Files selected for processing (3)

• package.json (1 hunks)
• src/index.ts (1 hunks)
• src/router.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• package.json

Additional comments not posted (2)

src/index.ts (2)

5-5: OpenAPIHono のインスタンスが正しく初期化されています。この変更により、APIのハンドリングが向上することが期待されます。

---

11-16: APIドキュメントの設定が適切に行われています。このドキュメントにより、APIの利用者がより簡単にAPIを理解し、使用することができるようになります。