REST API Developer support

Proposal Idea

Often times while working on Cumulocity microservice which makes use of the Cumulocity platform API there is a need to be aware of the existing APIs that can be leveraged, signature of the APIs i.e. request object it takes and the returned response object. Also during the unit testing at time there is a need to invoke these platform APIs to trigger or test a microservice or some module.

To achieve this Postman is often used where first the Cumulocity API collections are to be imported and then global variables are set and API then return response only after proper authorization.

Objectives

The objective of this idea is to make the usage of Cumulocity platform APIs lot more user friendly for usage in any phase of microservice development lifecycle.

• The provision has to be made in c8y portal which showcases all the existing APIs and their descriptions.

• The support to add sample input and output signature for all the APIs

• The Try Me feature where user can execute the API with the input (request body or input parameters) of his choice

• A feature to save the API calls with custom body or param for future use

• A feature to export all or selected APIs as Postman collection

• A feature to deploy the APIs to any other Cumulocity tenant

Idea posted by Faraz Khalid at "Pitch your Idea! GCC IoT

Example

Axonize IoT platform (competitor) provides a Swagger UI for complete REST API, which was used a lot of T-Systems. After the migration to Cumulocity they have lost this feature, they have to use postman collection.