Using Web Api I have an OData EndPoint which can return Products from a database.
I have multiple databases with similar schemas, and want to pass a parameter in the URL to identify which database the Api should use.
Current Odata Endpoint:
http://localhost:62999/Products
What I want:
http://localhost:62999/999/Products
In the new Url, I pass in 999 (the database ID).
The database ID is intended to specify which database to load the product from. For example localhost:62999/999/Products('ABC123')
would load product 'ABC123' from database 999, but the next request, localhost:62999/111/Products('XYZ789')
would load the product 'XYZ789' from database 111.
The Url below works, but I don't like it.
localhost:62999/Products('XYZ789')?database=111
Here is the code for the controller:
public class ProductsController : ErpApiController //extends ODataController, handles disposing of database resources
{
public ProductsController(IErpService erpService) : base(erpService) { }
[EnableQuery(PageSize = 50)]
public IQueryable<ProductDto> Get(ODataQueryOptions<ProductDto> queryOptions)
{
return ErpService.Products(queryOptions);
}
[EnableQuery]
public SingleResult<ProductDto> Get([FromODataUri] string key, ODataQueryOptions<ProductDto> queryOptions)
{
var result = ErpService.Products(queryOptions).Where(p => p.StockCode == key);
return SingleResult.Create(result);
}
}
I use Ninject to resolve which implementation of IErpService to inject into the controller by binding to a service provider:
kernel.Bind<IErpService>().ToProvider(new ErpServiceProvider());
And the ErpServiceProvider
inspects the url to identify the databaseId required by this request:
public class ErpServiceProvider : Provider<IErpService>
{
protected override IErpService CreateInstance(IContext context)
{
var databaseId = HttpContext.Current.Request["database"];
return new SageErpService(new SageContext(GetDbConnection(databaseId)));
}
}
The bit I am stuck on is how to define the Url parameter in the OData route config.
Normal WebApi routes can have parameters defined as follows:
config.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "api/{controller}/{id}",
defaults: new { id = RouteParameter.Optional }
);
But how do I define the parameters in the OData route config?
ODataModelBuilder builder = new ODataConventionModelBuilder();
builder.EntitySet<ProductDto>("Products");
builder.EntitySet<WorkOrderDto>("WorkOrders");
config.MapODataServiceRoute(
routeName: "ODataRoute",
routePrefix: null,
model: builder.GetEdmModel());
Is this even where I should be defining the Url parameters? I have also thought about using a Message Handler but I am not certain how this can be implemented either.
UPDATE
This question is trying to do the same thing as me: How to declare a parameter as prefix on OData
But it is not clear how the parameter is to be read from the url.
var databaseId = HttpContext.Current.Request["database"];
returns null currently.
Even after updating the route config to the following:
public static void Register(HttpConfiguration config)
{
// Web API routes
config.MapHttpAttributeRoutes();
config.Routes.MapHttpRoute(
name: "ErpApi",
routeTemplate: "{database}/{controller}"
);
// Web API configuration and services
ODataModelBuilder builder = new ODataConventionModelBuilder();
builder.EntitySet<ProductDto>("Products");
builder.EntitySet<WorkOrderDto>("WorkOrders");
config.MapODataServiceRoute(
routeName: "ODataRoute",
routePrefix: "{company}/",
model: builder.GetEdmModel());
config.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "api/{controller}/{id}",
defaults: new { id = RouteParameter.Optional }
);
}