.NET implementation of the OGC API family of standards
OgcApi.Net is a .NET implementation of the OGC API family of standards for working with geospatial data. It supports modular API building blocks to spatially enable Web APIs in a consistent way, using the OpenAPI specification as the foundation.
Key features:
- Implements OGC API - Features, Tiles, and Schemas standards.
- Supports multiple data providers: SQL Server, PostgreSQL/PostGIS, SQLite/SpatiaLite, and MbTiles.
- Provides automatic API generation from metadata descriptions.
- Includes Swagger/OpenAPI documentation for API exploration and testing.
For detailed documentation, visit the project documentation on GitHub Pages.
The following packages are available:
| Package | Description | Link |
|---|---|---|
| OgcApi.Net | OGC API - Features implementation without specific data providers |  |
| OgcApi.Net.SqlServer | SQL Server features data provider implementation |  |
| OgcApi.Net.PostGis | PostgreSQL/PostGis features data provider implementation |  |
| OgcApi.Net.SpatiaLite | SQLite/SpatiaLite features data provider implementation |  |
| OgcApi.Net.MbTiles | MbTiles tiles provider implementation |  |
| OgcApi.Net.Schemas | Schemas standard implementation |  |
To get started with OgcApi.Net, you need to install the core package and at least one data provider package depending on your database or data source. Below are the available NuGet packages:
The core package provides the basic implementation of the OGC API standards but does not include specific data providers. Install it using:
dotnet add package OgcApi.NetDepending on your data source, install one or more of the following data provider packages:
-
SQL Server: For working with Microsoft SQL Server or Azure SQL Database.
dotnet add package OgcApi.Net.SqlServer
-
PostgreSQL/PostGIS: For working with PostgreSQL databases with PostGIS extension.
dotnet add package OgcApi.Net.PostGis
-
SQLite/SpatiaLite: For working with SQLite databases with SpatiaLite extension.
dotnet add package OgcApi.Net.SpatiaLite
-
MbTiles: For working with vector tiles stored in the MbTiles format.
dotnet add package OgcApi.Net.MbTiles
If you are using the SpatiaLite provider, you will need to add additional dependencies based on your operating system:
-
Windows:
dotnet add package Microsoft.Data.SQLite dotnet add package mod_spatialite
-
Linux/macOS:
dotnet add package SQLitePCLRaw.bundle_sqlite3
Additionally, if deploying to Linux or macOS, it is recommended to install the SpatiaLite library on your operating system:
-
Debian/Ubuntu:
apt-get install libsqlite3-mod-spatialite
-
macOS:
brew install libspatialite
For more details about installation and configuration, see the Installation Guide.
-
Create an ASP.NET Core WebAPI project.
-
Install the required NuGet packages.
-
Configure the API in
Startup.cs:services.AddOgcApi("ogcapi.json");
-
Add controllers:
services.AddControllers().AddOgcApiControllers();
-
Run the application and access the API at
/api/ogc.
For a full setup guide, refer to the API Configuration Documentation.
We welcome contributions from the community! Whether you're fixing bugs, improving documentation, or adding new features, your help is greatly appreciated.
Here are some ways you can contribute:
- Bug Reports: If you encounter any issues, please open a new issue in the GitHub Issues section.
- Feature Requests: Have an idea for a new feature? Let us know by creating an issue or submitting a pull request.
- Documentation Improvements: Help us improve the documentation by suggesting edits or clarifications.
- Code Contributions: Fork the repository, make your changes, and submit a pull request. Please ensure your code follows the project's coding standards.
Before contributing, please take a moment to review the following:
- Ensure your changes align with the project's goals and standards.
- Write clear and concise commit messages.
- Include tests for any new functionality or bug fixes.
This project is licensed under the MIT License. See the LICENSE file for details.