Available data
When the API is configured and started, the database datasources from the project are exposed as data to retrieve and set.
For every entity in the database, the following calls are available:
Post -> ServerURL/[DatasourceName]/[Entityname]/
Patch -> ServerURL/[DatasourceName]/[Entityname]/{Identifier}
Delete -> ServerURL/[DatasourceName]/[Entityname]/{Identifier}
Put -> ServerURL/[DatasourceName]/[Entityname]/{Identifier}
Get -> ServerURL/[DatasourceName]/[Entityname]/{Identifier}
Example:
A server hosted on localhost with the project containing a datasourse "CodolexData" with a table "Orders", you can retrieve order with ID 80 by
"http://localhost:8080/CodolexData/Orders/80"
Swagger documentation
The server contains an url to retrieve swagger data in JSON for the API.
So the documentation can be always be found at "[ServerURL]/api/swagger.json" by default.
Use a website like https://editor-next.swagger.io/ to view the documentation in a structured manner.
DMVCFramework System Controller
When viewing the swagger documentation, one other base for operations can be found, the "DMVC Framework System Controller"
These calls can be used to get specific information about the server and platform.
Severconfig -> information about the server, like request size and timeout
DescribePlatform -> information about the host of the server
DescribeServer -> information about the available endpoints in simple JSON format. This includes the database entitties and flow.
