41–50 of 74 posts
This so nice. Well done! I'll surely give it a try. I appreciate the fresh theme in particular. Nit: don't call them Swagger files — OpenAPI has been around long enough to warrant recognition.
you're right! I updated the description[1] to include OpenAPI since people do still loog for swagger :)
[1] Beautiful API references from Swagger/OpenAPI files
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.
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).
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.
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.
Ah that's fantastic news about the custom views with Vue.js components.
Feel free to email me (marc@scalar.com) or join the Discord if you have any questions, need any features or bugs fixed please reach out :)
Some context for the less-informed (like myself): > 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.
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 ( https://docs.scalar.com ). I liked the thoughtful implementation around customizations / versioning, etc. 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…
> It was tough to close the "Test request" window. - I wasn't sure how to interact with the product without more trial and error.
Ah, this is great feedback. We can make it more clear with a button, as well that you can hit escape.
> Add OpenAPI linting to the editor. ah, great idea. will triage this and get this in.
> Allow users to import an example spec from the initial Getting Started page. In the getting started page we have "import url, paste swagger" & "petstore + tableau + cmc" examples to import by clicking.
Did you mean to add it to the editor?
Ah that's very cool, back in the day I always would install redocly instead of swagger UI, great work with Redocly :)
Again I really appreciate the kind words and your time.
How does this differ from stoplight.io? Is it just another theme (not that we can’t use another theme)?
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 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... I feel stuck u…
we are cross the technical documentation spectrum solution, doing anything from end-user/dev API/guides to internal management of technical knowledge.
let me know if you'd like a demo, I'm the founder.
Earlier quoted context omitted.
This is great feedback that we'd love to take a closer look at. If you have a chance please reach out to marc@scalar.com and we can start working on some improvements.
After some more experimentation it looks like you don't support allOf/anyOf/oneOf which seems like a pretty big hole.
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.