Define a contract first design principle and show OpenAPI based spec

[computate]

Define a contract first design principle and show OpenAPI based spec

Hackathon Task for Team-19 Hackathon 2021

Task description:

The team will showcase how the contract first design principle works. The team will share the API design best practices and use them to define a contract for one the Curriikis Service. this API wil be OpanAPI v3 compatible. The team will also showcase how to use the contract to generate Java based stubs.

[aqeel-tkxel]

Curriki's use case is to create following API endpoint:

API Endpoint
GET|POST- /api/v1/google-classroom/h5p/ajax/content-user-data

Description
This API endpoint retrieves or persists user responses for an activity (H5P) in the database, as the user interacts with an assignment in Google Classroom.

Existing Source Code:
Defined route: https://github.com/ActiveLearningStudio/ActiveLearningStudio-API/blob/3be9308f69bd756471a0399cc6f15d1ec33fc6f5/routes/api.php#L264

Controller method: https://github.com/ActiveLearningStudio/ActiveLearningStudio-API/blob/3be9308f69bd756471a0399cc6f15d1ec33fc6f5/app/Http/Controllers/Api/V1/H5pController.php#L609