docs: add openapi guide

[RihanArfan]

❓ Type of change

• 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality like performance)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Adds openapi docs page

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
nitro.build	Ready	Preview, Comment	Apr 10, 2026 3:28pm

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6cdd89c6-61f1-4671-98b1-9693e39bb324

📥 Commits

Reviewing files that changed from the base of the PR and between 896186a and 8be5b94.

📒 Files selected for processing (3)

• docs/1.docs/50.openapi.md
• src/types/config.ts
• src/types/openapi.ts

---

📝 Walkthrough

Walkthrough

Three documentation additions introduce OpenAPI support: a comprehensive guide explaining experimental OpenAPI generation, configuration, development endpoints, per-route metadata examples, and production considerations; plus JSDoc enhancements to type definitions documenting the new configuration options.

Changes

Cohort / File(s)	Summary
Documentation Guide docs/1.docs/50.openapi.md	New page documenting Nitro's experimental OpenAPI 3.1.0 support, including configuration setup, development endpoints, per-route metadata examples, schema hoisting, automatic tagging, and production deployment options.
Type Documentation src/types/config.ts, src/types/openapi.ts	Added JSDoc blocks and reference comments to NitroOptions.openAPI, NitroOptions.experimental.openAPI, and NitroOpenAPIConfig interface for improved type definition documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title 'docs: add openapi guide' follows conventional commits format with 'docs' scope and clearly describes adding OpenAPI documentation.
Description check	✅ Passed	The pull request description clearly indicates this is a documentation change that adds an OpenAPI docs page, which aligns with the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/openapi

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/nitro@4198

commit: 8be5b94