Hacker News new | ask | show | jobs
by squiggy22 983 days ago
100s of endpoints with various evolving payloads across 100s of developers.

The problem space is shared documentation, not 'make http request'

1 comments

I think OpenAPI is a better choice for this kinda stuff. The API docs are the source code and less lock-in that way. Devs can still use the tools they want.
OpenAPI only describes the endpoints. Ultimately people want examples and to test their endpoints collaboratively rather than just see a description of it with the fields it accepts. Actual use cases and a proper flow of being able to authenticate and use that token to call the other APIs and check the responses is what people seem to want more than a "dumb" curl GUI
OpenAPI has example capabilities built in and there are many interfaces for turning the specs into WebUI

https://swagger.io/docs/specification/adding-examples/