Skip to content

Latest commit

 

History

History
14 lines (10 loc) · 1.2 KB

README.md

File metadata and controls

14 lines (10 loc) · 1.2 KB
Raw

OpenAPI of the Courses domain

This folder contains the OpenAPI specification of the REST API implementations serving as examples in this project. The described API provides an additional domain-specific abstraction of the courses domain1. The intention of this abstraction is to provide an example on how the use of modelix can be abstracted for eventual consumer apps, such as the Angular based dashboard). The development process thus can follow a API-first approach. Consequently, this openAPI provides a contract of the API behaviour for web teams and a language engineers.

Footnotes

  1. This additional abstraction admittedly does not really provide fancy abstractions for this domain. Its purpose is rather educational for you to understand the option to add an additional layer separating web development from language engineering. You do not have to do this. Of course one does not necessarily need such an abstraction layer - any dashboard or web app can directly communicate with the API provided by the model-server together with the generated model API. ↩