Tree Sturgeon πŸš΄πŸ»β€β™‚οΈπŸŒπŸ”₯ Profile picture
Talking about climate action, including what you can do to help. Tech people @ me if you’re looking for climate OSS projects or jobs. DevRel @stoplightio.
24 Apr 20
In ye olden days you needed to write API descriptions by hand, in text, with a keyboard, which took FOREVER.

These days there are awesome GUI Editors, and an interesting new generation of OpenAPI-aware frameworks are appearing, like annotations but good. dev.to/philsturgeon/t…
This cover image, which has been cropped funny and wont be removed, is a visual depiction of how useful Annotation/Comment-based tools usually are.

I got a mention in @libel_vox's awesome tinyletter.com/NetAPINotes/ for this.

tl:dr; Do not confuse proximity with accuracy
The only disagreements I've had with this article were "Um, well achtually, you don't have to write it ALL by hand, you can copy and paste some stuff to speed you up!"

Ooof. I mean, you CAN, but using $ref to split things up is way more useful. stoplight.io/blog/keeping-o…
Read 4 tweets