My Authors
Read all threads
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…
If you’re paying for tools which force your team to memorise nested YAML structures then probably start looking at some more modern tools which have moved beyond ye olden days.
- Several: openapi.tools/#gui-editors
- The one I work on: stoplight.io/studio/
#ApiDesign @OpenApiSpec
Missing some Tweet in this thread? You can try to force a refresh.

Enjoying this thread?

Keep Current with Tree Sturgeon 🚴🏻‍♂️🌍🔥

Profile picture

Stay in touch and get notified when new unrolls are available from this author!

Read all threads

This Thread may be Removed Anytime!

Twitter may remove this content at anytime, convert it as a PDF, save and print for later use!

Try unrolling a thread yourself!

how to unroll video

1) Follow Thread Reader App on Twitter so you can easily mention us!

2) Go to a Twitter thread (series of Tweets by the same owner) and mention us with a keyword "unroll" @threadreaderapp unroll

You can practice here first or read more on our help page!

Follow Us on Twitter!

Did Thread Reader help you today?

Support us! We are indie developers!


This site is made by just two indie developers on a laptop doing marketing, support and development! Read more about the story.

Become a Premium Member ($3.00/month or $30.00/year) and get exclusive features!

Become Premium

Too expensive? Make a small donation by buying us coffee ($5) or help with server cost ($10)

Donate via Paypal Become our Patreon

Thank you for your support!