Improve bit Boilerplate scalar integration (#11582)

[ysmoradi]

closes #11582

Summary by CodeRabbit

• Documentation

  • Updated dependency injection and service registration documentation to reflect current implementation
  • Refined PWA configuration documentation to clarify service worker endpoint routing behavior

• Performance

  • Implemented response caching for API endpoints and documentation interfaces to improve system responsiveness
  • Enhanced API endpoint handling with improved documentation exclusion capabilities

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation clarifies service registration flow and service worker URL handling. API middleware configuration adds response caching to OpenAPI/Scalar endpoints and excludes specific routes from automatic description generation.

Changes

Cohort / File(s)	Summary
Documentation Updates src/Templates/Boilerplate/Bit.Boilerplate/.docs/09- Dependency Injection & Service Registration.md, src/Templates/Boilerplate/Bit.Boilerplate/.docs/12- Blazor Modes, PreRendering & PWA.md	Clarifies AddServerApiProjectServices() method now only calls AddIdentity(). Replaces explicit service worker bypass URL patterns with placeholder notation.
API Middleware Caching src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Program.Middlewares.cs, src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.Middlewares.cs	Adds CacheOutput("AppResponseCachePolicy") to MapOpenApi() and MapScalarApiReference() endpoints. Includes ExcludeFromDescription() on specific minimal API routes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Focus areas: Verify that caching policy identifier "AppResponseCachePolicy" is defined in application configuration and that ExcludeFromDescription() does not unintentionally hide required API documentation.
• Cross-file consistency: Confirm that middleware changes are identical patterns applied to both Server.Api and Server.Web projects.

Poem

🐰 A Scalar dream takes shape so bright,
With caching swift and docs just right,
OpenAPI endpoints now respond with speed,
The Boilerplate has all it'll need! ✨

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between b83a111 and ce4f984.

📒 Files selected for processing (4)

• src/Templates/Boilerplate/Bit.Boilerplate/.docs/09- Dependency Injection & Service Registration.md (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/.docs/12- Blazor Modes, PreRendering & PWA.md (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Program.Middlewares.cs (2 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.Middlewares.cs (2 hunks)

---

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.}