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. People Don't Know What Your API Does if You Don't Showcase It

People Don't Know What Your API Does if You Don't Showcase It

From my experience in the space, people eat up simple, easy-to-read examples of APIs solving problems, and providing solutions.

Kin Lane user avatar by
Kin Lane
·
Oct. 28, 16 · Opinion
Like (0)
Save
Tweet
Share
2.59K Views

Join the DZone community and get the full member experience.

Join For Free

With a lot of my storytelling, I feel like captain obvious, but I also recognize the importance of simple (and sometimes repetitive) storytelling to help reach my audience of time- and resource-strapped API providers. Sometimes, API providers are just too busy to remember the small things. This is where I come in to help you remember some of the most obvious aspects of providing APIs that can be essential to success.

This morning's reminder is that nobody will know the cool things your API does if you do not showcase what is being done with it. This is why I added my API showcase research: to highlight the approach of the successful API providers and to give me a regular reminder to write about the topic. I understand you are busy, but so are your API consumers. There is a good chance they need a little help understanding what can be done with your super valuable API resource(s).

Showcasing your successful API integrations is where the rubber meets the road with API operations. Tell us all about the cool things people are doing with your APIs. It doesn't have to be a full-blown case study (although that would be nice, too). It can be 250 words, plus some bullets, and another 250 words, helping us understand the possibilities in two minutes or less. From my experience in the space, people eat up these simple, easy-to-read examples of APIs solving problems, and providing solutions.

Ideally, you are showcasing the cool things being done with your API on a regular basis via your blog, but if for some reason you're too busy, make sure to at least share your thoughts with me via email. You never know; if it is worthy, I might take the time to share here on API Evangelist.

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

  • Top 5 PHP REST API Frameworks
  • Remote Debugging Dangers and Pitfalls
  • Implementing Infinite Scroll in jOOQ
  • Top 5 Node.js REST API Frameworks

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: