Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(openapi): add experimental /_nitro/scalar endpoint #2252

Merged
merged 7 commits into from
Mar 15, 2024

Conversation

hanspagel
Copy link
Contributor

@hanspagel hanspagel commented Mar 13, 2024

πŸ”— Linked issue

n/a

❓ 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

Nitro looks so cool! I saw you've added Swagger UI. We’re building a more modern OSS alternative to Swagger UI here: https://github.com/scalar/scalar It’s already integrated by default, or available as a package in/for Express, Fastify, Platformatic, Hono, ElysiaJS, Next.js, Laravel … and more. πŸ˜‡

This PR adds /_nitro/scalar as an additional route to render OpenAPI files. And we’ve added a custom theme that matches the Nitro docs. What do you think? Really looking forward to your feedback!

nitrovideo.mp4

πŸ“ Checklist

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

@pi0 pi0 changed the title feat(openapi): Scalar OpenAPI reference feat(openapi): add experimental /_nitro/scalar endpoint Mar 15, 2024
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is amazing! Let's merge and iterate over this.

I think eventually we might use scalar as nitro's default OpenAPI explorer!

@pi0 pi0 marked this pull request as ready for review March 15, 2024 23:30
@pi0 pi0 merged commit ebab970 into nitrojs:main Mar 15, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants