Support software developers

You should aim for customer-oriented management of the API deployment process. From a business perspective, this involves the Customer Value Chain, which describes the process from identification of a need to deployment.

The developer experience is influenced by

• decisions made in the design phase
• in-service support.

See the list below for the features of a well-implemented API that optimise its efficiency, usability and life cycle length.

APIs are often difficult to use, and as a consequence software developers spend a lot of time learning about them.

Misuse can cause errors and information security problems.

A study (Thayer et al.Opens in a new window. 2021.Opens in a new window. A Theory of Robust API Knowledge.Opens in a new window. ACM Transactions on Computing EducationOpens in a new window.) found that developers need three types of information about APIs:

1. Domain information: The API describes a domain and uses its terminology. Clear documentation improves usability.
2. Usage patterns: How the API is used and the rationale for different ways of using it.
3. Description of execution: How the API works (prompts and outputs) and how it integrates into the application

Good documentation has multiple layers. It provides quick-start information about the functioning and usage situations of the API, as well as examples (FAQs). Even extensive documentation can be summarised on a web page.

APIs are developed to be used, and documentation of APIs published for external use is of crucial importance. Outsiders may not be familiar with the terms used within the organisation. You should note that information on APIs is sought by business and software developers, who have different information needs.

You should support API deployment in different ways.

Good usability comes from something that

• can be learned
• can be remembered
• is efficient in use
• has few errors
• is pleasant to use.

The developer experience can also be examined in terms of support provided during the API life cycle:

1. Finding the API
2. Understanding it (what it does, how it works)
3. Deployment
4. Support while in use
5. Retiring.

Developer experience consists of a variety of tools and instructions, and it is important to ask developers to give feedback on which of these help their work.

Analysing API usage can also provide valuable information on its use.