Wow -- this is quite impressive. I'm delighted to see new offerings in this space. Kudos to the team!
I spent some time tinkering with the deployed preview (<a href="https://docs.scalar.com" rel="nofollow noreferrer">https://docs.scalar.com</a>). I liked the thoughtful implementation around customizations / versioning, etc.<p>Some places I hit friction while exploring:
- It was tough to close the "Test request" window.
- I wasn't sure how to interact with the product without more trial and error.<p>Two suggestions I thought might be useful:
1. Add OpenAPI linting to the editor. Right now it works with invalid specs as long as long the JSON is formatted correctly.
2. Allow users to import an example spec from the initial Getting Started page. (The editor is a good home for it, too, but I would have found it sooner).<p>Disclosure: I'm a Redocly employee, but have managed doc projects in a variety of tools. This is a neat approach! Great work and congrats.
I'm interested in new offerings in this area, as all of the existing options are pretty janky. A couple of thoughts:<p>Operation.summary is typically derived from the documentation for an API operation, and should not be used as the operation title as it is far too long. Instead use the operationId and path.<p>I can't get it to render schemas for a bunch of my OpenAPI documents, and there are no error messages to guide me. Does this handle recursive schemas (which can never be fully expanded)?
This so nice. Well done! I'll surely give it a try. I appreciate the fresh theme in particular.<p>Nit: don't call them Swagger files — OpenAPI has been around long enough to warrant recognition.
Some context for the less-informed (like myself):<p>> The OpenAPI Specification, previously known as the Swagger Specification
is a specification for a machine-readable interface definition language for
describing, producing, consuming and visualizing web services.
Nice project. The space is crowded with many similar products. I couldn't get any primary differentiators between it and similar products already mentioned in this thread<p>I prefer self-hosted or internally managed product only! However, what's really hard to find is a solution that integrates with technical & business documentation stacks. If anyone knows any good products please please please share...<p>I feel stuck using a frustrating product like Confluence and tried a few open source alternatives but couldn't get conviction to switch (bad vs worse). We've been trying 'swimm.io' but everybody has to go out of their way to incorporate it into their workflow, sooo nobody really using it! It doesn't help that most of us use vim/neovim and not IDEs ... majority of engineers don't really like the documentation part of their work and most tools make it worse!
I think the perfect use-case for this would be to embed it in a application, kind of like GraphQL Playground. Not sure I'd use it for user-facing documentation though, as it seems it doesn't have SSR or HTML output. Docusaurus Integration would be nice for that reason.
Hey HN, Marc co-founder & CEO of scalar here!<p>Thanks so much for your thoughtful feedback and giving our first open sourced tool a try. Please don't hesitate to reach out here or email me directly at marc@scalar.com if you have any feedback or if I can help you in any way shape or form with your API.
Awesome! I recently encountered the need of expanding a Spring Boot Admin instance to offer OpenAPI docs for custom Spring Boot Actuator endpoints which are in their own group, hidden from the main API. As SBA requires custom views to be Vue.js components, this will probably fit pretty nicely.
I’m having a lot trouble navigating it on Safari for iOS on iPad.<p>- The top bar disappears behind the navigation bar of Safari and there doesn’t seem to be a way to get it to reappear.
- I tried to refresh the page to see if it would re-render and put the bar below the navigation bar, but I can’t pull down to refresh. Something is floating a window inside the window and I’m just pulling that around.
- Tried clicking refresh in the nav bar and it didn’t fix the hidden top bar.
- It’d be nice to be able to collapse the swagger editor in the reference view. Right now the left navigation is separated from the documentation and request tester on the right by 1/3rd of the screen (that is not being used at all).
I like your project. Glad to see alternatives to this <a href="https://docusaurus-openapi.netlify.app/" rel="nofollow noreferrer">https://docusaurus-openapi.netlify.app/</a>
Looks like a similar solution to <a href="https://github.com/stoplightio/elements">https://github.com/stoplightio/elements</a> - will give this a whirl some time!
Looks very JavaScripty.<p>I like my API documentation to mainly be boring old static HTML, with any interactive features using JavaScript layered over the top.<p>Using HTML makes it faster to load, easier to get it indexed by search engines, easier to save and run offline and easier to process through LLM tools like ChatGPT and Claude.