Hacker News new | ask | show | jobs
by frio 3710 days ago
That sounds very much like [API Blueprints](https://apiblueprint.org/), which [Apiary](https://apiary.io/) back. I tried to get the organisation I work for to standardise on them (being able to run tests from a versioned API specification seemed like a fantastic way to hit two birds with one stone), but sadly, couldn't convince enough people.
2 comments
seanp2k2 3710 days ago
It also sounds like Swagger + OpenAPIs: https://openapis.org
link
ewittern 3710 days ago
What were the reasons people brought up against doing this?
link
frio 3709 days ago
Mostly inertia. We're a large-ish company; I work in a remote office away from the majority of dev, and technical direction needs marketing.

We ended up using Swagger, which doesn't solve as many of our problems (having documentation generated from code isn't as robust from a testing POV, particularly when your RESTful API is versioned), but my "perfect" is the enemy of the company's "good" :).

link