Comments
yourfanat wrote: I am using another tool for Oracle developers - dbForge Studio for Oracle. This IDE has lots of usefull features, among them: oracle designer, code competion and formatter, query builder, debugger, profiler, erxport/import, reports and many others. The latest version supports Oracle 12C. More information here.
Cloud Expo on Google News
SYS-CON.TV

2008 West
DIAMOND SPONSOR:
Data Direct
SOA, WOA and Cloud Computing: The New Frontier for Data Services
PLATINUM SPONSORS:
Red Hat
The Opening of Virtualization
GOLD SPONSORS:
Appsense
User Environment Management – The Third Layer of the Desktop
Cordys
Cloud Computing for Business Agility
EMC
CMIS: A Multi-Vendor Proposal for a Service-Based Content Management Interoperability Standard
Freedom OSS
Practical SOA” Max Yankelevich
Intel
Architecting an Enterprise Service Router (ESR) – A Cost-Effective Way to Scale SOA Across the Enterprise
Sensedia
Return on Assests: Bringing Visibility to your SOA Strategy
Symantec
Managing Hybrid Endpoint Environments
VMWare
Game-Changing Technology for Enterprise Clouds and Applications
Click For 2008 West
Event Webcasts

2008 West
PLATINUM SPONSORS:
Appcelerator
Get ‘Rich’ Quick: Rapid Prototyping for RIA with ZERO Server Code
Keynote Systems
Designing for and Managing Performance in the New Frontier of Rich Internet Applications
GOLD SPONSORS:
ICEsoft
How Can AJAX Improve Homeland Security?
Isomorphic
Beyond Widgets: What a RIA Platform Should Offer
Oracle
REAs: Rich Enterprise Applications
Click For 2008 Event Webcasts
Developer Experience: The Key to a Successful API | @CloudExpo #API #Cloud #Analytics
'Good' Developer Experience is all about understanding and catering to your customers' needs

Developer Experience: The Key to a Successful API
By Caroline Ambros

User experience is the key to adoption. If no one understands how to use your product, they won't buy it. This is equally true in the world of APIs. Developers are more likely to adopt and stick with a platform or service that they enjoy using. The key to the success of your API, then, is the Developer Experience.

But what is Developer Experience?
Much like for products that target traditional consumers, the usability of your API is key. Thus, the Developer Experience is the aggregate of all experiences a developer has while interacting with your platform. At the intersection of business, technology and UX, your platform's Developer Experience could make or break your organization's growth in today's incredibly competitive technological landscape.

"Good" Developer Experience is all about understanding and catering to your customers' needs. To do this, you must also understand who your customer is. One mistake that many software organizations make is misunderstanding who their audience is. Your API doesn't only need to be easy to use for a technical audience, but also for API decision makers, because although they are often less technical, they will decide if their team ultimately adopts your platform.

As your API needs to appeal to technical and non-technical people alike, the entire adoption process for your API should be as straight forward as possible.

Your consumers will seek answers to four questions on their journey from discovery to consumption of your API.

  1. Why should I use it?
  2. How do I register?
  3. Where do I start?
  4. How do I use it?

The answers to each of these questions should be clear to your users from the outset. For example, discovering your major value points should not be difficult, and registering for your service should require minimal effort and information. You can learn more about how to think about your API Developer Experience in slides 10 through 24 below.

Where API Documentation fits in:
API documentation is crucial in the final stages of your consumer's journey. These final stages are where your potential users will want to get their hands dirty with your API. But if no one understands how to use your API, they won't adopt it; therefore, you must ensure that your API documentation is clear and easy to understand regardless of your readership. You want to make sure that after reading your API documentation, developers and decision makers alike have no questions left unanswered. You can ensure this by following a few simple steps:

  1. List the Fundamentals

Specifically, make sure you clearly explain authentication, errors, end points, terms of use, and your changelog. Provide examples for all of the above and make sure that they are included in the right context.

  1. Write for Humans

Never assume that your audience is only developers that are familiar with API or domain jargon! Instead, write in plain English where possible, and provide context clues for any jargon that is absolutely necessary.

  1. Explain request-response cycles

Don't leave anything to the imagination of your users. Instead, include your full sample response body, including any errors that could appear. Provide examples and use cases to further clarify plausible scenarios.

  1. Empower with Experimentation

Experimentation is power! Allow developers to experiment with your API so that they can discover your value proposition before even adopting the API. To do this, provide "Getting Started" guides, SDKs, tutorials and interactive documents and consoles.

If you don't have the time to write out your API documentation try open source Swagger UI or SwaggerHub that allow you to write your API contract, and auto-generate the documentation.

Read the original blog entry...

About SmartBear Blog
As the leader in software quality tools for the connected world, SmartBear supports more than two million software professionals and over 25,000 organizations in 90 countries that use its products to build and deliver the world’s greatest applications. With today’s applications deploying on mobile, Web, desktop, Internet of Things (IoT) or even embedded computing platforms, the connected nature of these applications through public and private APIs presents a unique set of challenges for developers, testers and operations teams. SmartBear's software quality tools assist with code review, functional and load testing, API readiness as well as performance monitoring of these modern applications.

Latest AJAXWorld RIA Stories
CloudEXPO | DevOpsSUMMIT | DXWorldEXPO Silicon Valley 2019 will cover all of these tools, with the most comprehensive program and with 222 rockstar speakers throughout our industry presenting 22 Keynotes and General Sessions, 250 Breakout Sessions along 10 Tracks, as well as our ...
Your job is mostly boring. Many of the IT operations tasks you perform on a day-to-day basis are repetitive and dull. Utilizing automation can improve your work life, automating away the drudgery and embracing the passion for technology that got you started in the first place. In...
Technological progress can be expressed as layers of abstraction - higher layers are built on top of lower layers treating them as abstract black boxes with known interfaces. A serverless approach represents an inflection point that entirely separates the runtime layer from the u...
Bill Schmarzo, Tech Chair of "Big Data | Analytics" of upcoming CloudEXPO | DXWorldEXPO New York (November 12-13, 2018, New York City) today announced the outline and schedule of the track. "The track has been designed in experience/degree order," said Schmarzo. "So, that folks w...
Big Switch's mission is to disrupt the status quo of networking with order of magnitude improvements in network e ciency, intelligence and agility by delivering Next-Generation Data Center Networking. We enable data center transformation and accelerate business velocity by delive...
Subscribe to the World's Most Powerful Newsletters
Subscribe to Our Rss Feeds & Get Your SYS-CON News Live!
Click to Add our RSS Feeds to the Service of Your Choice:
Google Reader or Homepage Add to My Yahoo! Subscribe with Bloglines Subscribe in NewsGator Online
myFeedster Add to My AOL Subscribe in Rojo Add 'Hugg' to Newsburst from CNET News.com Kinja Digest View Additional SYS-CON Feeds
Publish Your Article! Please send it to editorial(at)sys-con.com!

Advertise on this site! Contact advertising(at)sys-con.com! 201 802-3021


SYS-CON Featured Whitepapers
Most Read This Week
ADS BY GOOGLE