Skip to content

Latest commit

 

History

History
91 lines (59 loc) · 4.72 KB

README.md

File metadata and controls

91 lines (59 loc) · 4.72 KB
Raw

Mapify - Your Guide to Global Coordinates

Build and Test Super-Linter Github License

This solution offers a Geocoding API tailored for Pakistani cities, enabling developers to effortlessly fetch the latitude and longitude coordinates of a specified city. The API boasts simplicity and user-friendliness, making it seamless to integrate into both web and mobile applications. Beyond the Geocoding API for Pakistani cities, this solution also includes JSON files for World Cities, furnishing latitude and longitude coordinates for cities globally.

Technologies

Prerequisites

  • Visual Studio or any other compatible IDE
  • .NET Framework or .NET Core
  • OData packages installed in the project

Installation

  • Clone the repository to your local machine.
  • Open the project in Visual Studio or any other compatible IDE.
  • Reach out to the solution directory by using cd Mapify
  • Build and run by using dotnet run or build the project to install the required dependencies.

Database Configuration

The solution is configured to use Pakistan cities' data by default. This ensures that all users will be able to run the solution without needing to set up additional infrastructure (e.g. SQL Server).

Verify that the DefaultConnection connection string within appsettings.json points to a valid SQL Server instance.

If you want to run the application with the World Cities JSON file then the latest migrations will be applied.

Overview

This will contain all entities, Odata handling, exceptions, interfaces, logging, persistence brokers types, and logic specific to the solution.

OData Implementation in .NET WebAPI Application

This repository contains an implementation of OData in a .NET WebAPI application using the ODataConventionModelBuilder. OData is a standardized protocol for creating and consuming RESTful APIs that expose data as resources and support advanced querying capabilities.

Usage

To use OData in your WebAPI application, you need to create an instance of ODataConventionModelBuilder and configure it to include the entities you want to expose through OData. The following code snippet shows an example of how to create the EDM model for the GeoLookup entity.

 static IEdmModel GetEdmModel()
{
   ODataConventionModelBuilder builder = new();
   builder.EntitySet<GeoLookup>("Geos");
   return builder.GetEdmModel();
}

Once you have created the EDM model, you can enable OData in your application by adding the OData middleware to the pipeline. The following code snippet shows an example of how to configure the OData middleware in your application.

builder.Services.AddControllers().AddOData(opt => opt.EnableQueryFeatures().AddRouteComponents("odata", GetEdmModel()));

Finally, you can use the [EnableQuery] attribute to enable advanced querying capabilities in your API controllers. The following code snippet shows an example of how to use the [EnableQuery] attribute to set the page size to 100.

[EnableQuery(PageSize = 100)]
public IActionResult Get()
{
   //...
}

OData Features

  • $top : Retrieve only the top N records from the result set. Example: http://localhost:5000/odata/Geos?$top=10.

  • $skip: Skip the first N records from the result set. Example: http://localhost:5000/odata/Geos?$skip=10.

  • $orderby: Order the result set by one or more properties. You can specify the order direction using the asc or desc keyword. Example: http://localhost:5000/odata/Geos?$orderby=Name asc.

  • $count: Include a count of the total number of records in the result set. Example: http://localhost:5000/odata/Geos?$count=true.

For more information on OData and its query options, please refer to the OData documentation.

Support

If you are having problems, please let us know by raising a new issue.

License

This project is licensed under the MIT license.