DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
  1. DZone
  2. Data Engineering
  3. Databases
  4. The 3 Layers of API Hype

The 3 Layers of API Hype

After your API is up and running, step back, re-read everything, and think about the synchronicity between the marketing, the documentation, and the API itself.

Kin Lane user avatar by
Kin Lane
·
Mar. 16, 17 · Opinion
Like (7)
Save
Tweet
Share
6.19K Views

Join the DZone community and get the full member experience.

Join For Free

I read a lot of content about APIs. I read a lot of redundant and fluffy marketing and technical jargon trying to understand exactly what an API does or doesn't do. Before I criticize, I have to admit that crafting really good API marketing and documentation is hard. Only about 5% of what I read is good; a significant portion is just incomplete and lazily done by someone who doesn't care. The rest is actually incorrect, misleading, and straight-up hype.

There are three layers to the API hype onion in my experience:

  • Marketing: The fluff on the main page written by the marketing team who usually doesn't care about the API and hasn't taken the time to get to know what it does.
  • Documentation: The technical fluff in the API portal usually written by someone technical and not quite possessing the skills to talk to humans — let alone coherently explain something to another human being.
  • API: The actual naming, ordering, parameters, and overall request and response structure for an API that actually accomplishes something. It may not always accomplish exactly what I'm looking for, but at least it is something.

While I still read marketing and documentation because they provide me with clues about the intent behind API operations, when I actually want the honest take on what an API does, I always go straight to the API and get to work making API calls. This is a problem that is only increasing as we enter into the Artificial Intelligence and Machine Learning hype phase.

After you finish writing the marketing and documentation and have your API up and running, step back, and re-read everything, and think about the synchronicity between these three areas of your operations. It takes a lot of practice and hard work to do right, but I think if you just take a moment, step back, and think about these layers to how you articulate what your APIs does, you will immediately find yourself in a better position to communicate what it is you are trying to accomplish to a much wider audience.

API

Published at DZone with permission of Kin Lane, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • Kotlin Is More Fun Than Java And This Is a Big Deal
  • Iptables Basic Commands for Novice
  • How Do the Docker Client and Docker Servers Work?
  • Java Development Trends 2023

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: