HNHacker News
TopNewBestAskShowJobs

BearEatingBees

7 karma · joined September 24, 2017

submissionscomments
BearEatingBees··on Scalar: Generate interactive API documentations from Swagger files
Many tools in this space have overlapping functionality, but have a lot of differences when it comes to building with them or consuming information from them. The products take shape around opinionated solutions that are fundamentally different. So, while they "do the same thing", some have better tools for API authoring, some are more usable for non-technical stakeholders, some emphasize performance, some emphasize extensibility, etc. A good analogy is cars. They all drive, but some have 4WD, some have truck beds.
BearEatingBees··on Scalar: Generate interactive API documentations from Swagger files
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 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.