Abstract

Application Programming Interface (API) is a set of routines, protocols, and tools for building software applications. Insufficient or inadequate explanation and examples of the API’s structure and its usage present an obstacle for developers trying to learn an API. As a result, well documented APIs that enhance the experience for developers, became an essential requirement for defining an API's success. The most common way to document Web APIs today is to produce documentation that accurately lists the API endpoints, and describes the allowable operations on each, making the APIs more precise and readable. There are various tools that allow you to do this in an automated or semi-automated way. However, there is a lack of a common and proven concept of how to introduce the developers to an API and train them how to integrate APIs into their systems respectively. Therefore, we propose A Concept for the Design of Learning Resources for APIs of Content Management Platforms (CMS) that will provide an interactive tutorial, which will allow developers to easily comprehend and learn how to use the specific API endpoints. The evaluation of our proposal has been made on a next generation CMS system SocioCortex and its REST API, which we have extended with our proposed model.