Hacker News new | ask | show | jobs
by marclave 975 days ago
Hey HN, Marc co-founder & CEO of scalar here!

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.

1 comments

This is really cool from a documentation standpoint and I love that there's an open source project encroaching in this space.

That said, I don't just use Open API for documentation. I use it to generate clients and servers so that my customers can easily upgrade versions or generate them themselves. Are there any plans to formulate examples from those generated clients? That, today, has to be hand annotated if you want the custom examples (beyond REST) to appear in the API documentation.

co-founder here :) Appreciate the kind words!

Our plans are to make it easier to integrate with existing SDK generation tools so you can use them inside of our API docs.

https://www.speakeasyapi.dev/ is a really great platform and I think we can integrate with them and have examples from custom SDKs.

In the scenario with custom domains, we would have to rely on docstrings or comments depending on the language, I'll need more thought on that