Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Making Web Concepts and Specs Present as Real Time Help in API Design Tooling

DZone's Guide to

Making Web Concepts and Specs Present as Real Time Help in API Design Tooling

Why don't IDEs like IntelliJ, Eclipse, and Visual Studio start including autocomplete functionality for Web API design?

· Web Dev Zone ·
Free Resource

Learn how error monitoring with Sentry closes the gap between the product team and your customers. With Sentry, you can focus on what you do best: building and scaling software that makes your users’ lives better.

I took the GitHub repository for Erik Wilde's (@dret) Web Concepts work and forked it, then generated some JSON which I could use to import into my API monitoring system. I've been manually adding specs to my Tweet and LinkedIn scheduling system, but I keep forgetting to go back to the site and add more entries. So I wanted to go ahead and import all the concepts and specs, and schedule out the tweets and LinkedIn posts for everything, over the next couple months.

First I generated the JSON for the concepts, then I generated the JSON for the specs, which you can see here.

I left out the relationships between the concepts and specs, as I will just be linking to Web Concepts, and let people explore for themselves. As I was looking through the JSON it got me thinking about why these concepts and specs aren't available in API design tooling as helpers and tooltips, so that API designers and architects can learn from them and be reminded in real time —as they are crafting their APIs. 

It seems like there should be autocomplete for HTTP header fields, HTTP status codes, and other relevant items as they are needed. There is a wealth of web literacy available in Erik's work, and across the web concepts and specs he has organized, it seems like these should be available by default within API design services and tooling, and start being baked into IDEs like Atom, Eclipse, and Visual Studio. Maybe they already are, and I'm just unaware.

What’s the best way to boost the efficiency of your product team and ship with confidence? Check out this ebook to learn how Sentry's real-time error monitoring helps developers stay in their workflow to fix bugs before the user even knows there’s a problem.

Topics:
api ,web dev

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}