REST APIs

In addition to a the basic API's, you can also have it create more complex API's structures, such as REST endpoints.

This can be done by adding a MalleableRestApiFileServer to the UseEndpoints section of your host configuration.

.UseEndpoints(cfg =>
{
    var malleableApi = new MalleableRestApiFileServer(basePath: basePath);
    malleableApi.Process(cfg, malleableTypes); // Add an enumerable list of malleableTypes to be processed
});

The basePath identifies where on the local file system it should save the files. When combined with mounts in Kubernetes, this can be a shared data source with multiple services.

Please also note that when using a REST API structure, the models included must have an identifierExpression defined.

It will create the following endpoints:

# Gets a list of the available items currently saved
GET /api/namespaces/{basePath}/{moduleNamespace}/{moduleName}/{className} 

# Gets a unique item based upon its identifier
GET /api/namespaces/{basePath}/{moduleNamespace}/{moduleName}/{className}/{identifier}

# Creates an instance of the item
POST /api/namespaces/{basePath}/{moduleNamespace}/{moduleName}/{className}

# Updates an existing item with a new definition |
PUT /api/namespaces/{basePath}/{moduleNamespace}/{moduleName}/{className}/{identifier}

# Deletes an item
DELETE /api/namespaces/{basePath}/{moduleNamespace}/{moduleName}/{className}/{identifier}

It will access the files for each of the data types in the folder:

$"{basePath}/{moduleNamespace}/{moduleName}/{className}"

and each file will be named as follows:

$"{basePath}/{moduleNamespace}/{moduleName}/{className}/{identifier}.json"