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.
Scalar: Generate interactive API documentations from Swagger files
31–40 of 74 posts
Re: Scalar: Generate interactive API documentations from Swagger files
#32I'm interested in new offerings in this area, as all of the existing options are pretty janky. A couple of thoughts: 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. I can't get it to render schemas for a bunch of my OpenAPI documents, and there are no error messages to guide m…
I thought most of the alternatives used summary as a title and description as a body, which is how we've been writing it as well? Or am I out of wack here?
Re: Scalar: Generate interactive API documentations from Swagger files
#33Nice 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…
hey! ceo & co-founder here, some key differentiators. It definitely is a busy space, but we feel like there's some key differentiators:
- modern design - deeply integrated rest api client - free hosting with an apidocumentation.com subdomain - offline search with fuse.js - and more!
We also have a full api docs platform, where you can: - have full customization so you get on brand docs - subdomain & custom domain hosting
We put a lot of time to make these products integrated, cause what we see right now with current solutions is deep fragmentation.
I agree on most tools making it worse, long term we aim to make this better with a git sync feature and docstring parsing! :) -
Re: Scalar: Generate interactive API documentations from Swagger files
#34I 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.
Appreciate the comment!
Docusaurus integration is going to be the next one we do! Sign up and we can notify you there, on our discord or of course when we push it to github :)
Re: Scalar: Generate interactive API documentations from Swagger files
#35I 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.
ha love the username too :)
Re: Scalar: Generate interactive API documentations from Swagger files
#36Cool to see this.
I hate redocly and swagger UI , and all of "enterprisey" offering on an open standard like OpenAPI.
Re: Scalar: Generate interactive API documentations from Swagger files
#37Looks very JavaScripty. I like my API documentation to mainly be boring old static HTML, with any interactive features using JavaScript layered over the top. 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.
appreciate the comment!
the hosted version has SSG :) but we can probably do an ssg build option... going to triage that and maybe get that in over the weekend with some redbulls
Re: Scalar: Generate interactive API documentations from Swagger files
#38Why did you decide to open-source it? How will you make money? edit: why downvotes?
hey ceo & co-founder here!
First of all we love open-source, we saw a huge opportunity to bring a modern design and some new features to swagger-ui & redocly.
Great question how we make money! We currently have: - a premium plan for hosting with a custom domain and guides
Our longer term plan is to build a dedicated REST API Client that is deeply integrated with all of our produts.
Feel free to join our discord, email me marc@scalar.com or sign up on scalar.com to stay updated :)
Re: Scalar: Generate interactive API documentations from Swagger files
#39I'm interested in new offerings in this area, as all of the existing options are pretty janky. A couple of thoughts: 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. I can't get it to render schemas for a bunch of my OpenAPI documents, and there are no error messages to guide m…
hey! co-founder here, appreciate your comment.
Ah that's great feedback!
As for the rendering of the schemas, we have a pull request in draft from this morning! hopefully will be done ASAP
Re: Scalar: Generate interactive API documentations from Swagger files
#40I 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.
ha love the username too :)
If you type my username + .com, you'll know why ;)