Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opengeospatial/ogcapi-features
An open standard for querying geospatial information on the web.
https://github.com/opengeospatial/ogcapi-features
api features geospatial-data ogc ogc-api openapi standard wfs
Last synced: 2 months ago
JSON representation
An open standard for querying geospatial information on the web.
- Host: GitHub
- URL: https://github.com/opengeospatial/ogcapi-features
- Owner: opengeospatial
- License: other
- Created: 2017-07-31T15:26:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-31T11:40:52.000Z (3 months ago)
- Last Synced: 2024-10-31T12:29:26.238Z (3 months ago)
- Topics: api, features, geospatial-data, ogc, ogc-api, openapi, standard, wfs
- Language: CSS
- Homepage: https://ogcapi.ogc.org/features
- Size: 10.7 MB
- Stars: 340
- Watchers: 66
- Forks: 85
- Open Issues: 125
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - opengeospatial/ogcapi-features - An open standard for querying geospatial information on the web. (CSS)
README
# OGC API - Features
This GitHub repository contains [OGC](https://www.ogc.org)'s
multi-part standard for querying geospatial information on the web, "OGC API - Features".
All approved versions of the specification can be found [here](https://www.opengeospatial.org/standards/ogcapi-features).
[OGC API standards](https://ogcapi.ogc.org/) define modular API building blocks to spatially enable Web APIs
in a consistent way. [OpenAPI](https://openapis.org) is used to define the reusable
API building blocks with responses in JSON and HTML.
The OGC API family of standards is organized by resource type. OGC API Features
specifies the fundamental API building blocks for interacting with features.
The spatial data community uses the term 'feature' for things in the real world
that are of interest.
If you are unfamiliar with the term 'feature', the explanations on
[Spatial Things, Features and Geometry](https://www.w3.org/TR/sdw-bp/#spatial-things-features-and-geometry)
in the W3C/OGC Spatial Data on the Web Best Practice document provide more detail.
## Overview
OGC API Features provides access to collections of geospatial data.
```
GET /collections
```
Lists the collections of data on the server that can be queried ([section 7.13](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0#_collections_)),
and each describes basic information about the geospatial data collection, like its id and description, as well as the
spatial and temporal extents of all the data contained.
```
GET /collections/buildings/items?bbox=160.6,-55.95,-170,-25.89
```
Requests all the data in the collection "buildings" that is in the New Zealand economic zone.
The response format (typically HTML or a [GeoJSON](https://geojson.org/) feature
collection, but GML is supported, too, and extensions can easily supply others) is determined using
[HTTP content negotiation](https://restfulapi.net/content-negotiation/).
Data is returned in pageable chunks, with each response containing a `next` link
as many collections are quite large. The core specification supports a few basic filters, in
addition to the `bbox` filter above, with extensions providing more advanced options
([section 7.15](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0#_items_)).
```
GET /collections/{collectionId}/items/{featureId}
```
Returns a single 'feature' - something in the real-world (a building,
a stream, a county, etc.) that typically is described by a geometry plus other properties.
This provides a stable, canonical URL to link to the 'thing'
([section 7.16](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0#_feature_)).
See [here](https://github.com/opengeospatial/ogcapi-features/tree/master/extensions/crs) for
an overview of the extensions to support additional coordinate reference systems beyond WGS 84.
## Using the standard
The standard is on the OGC website:
* OGC API - Features - Part 1: Core
* [Version 1.0.1 (latest approved version)](https://docs.ogc.org/is/17-069r4/17-069r4.html)
* [Editor's draft (includes errata and clarifications)](https://docs.ogc.org/DRAFTS/17-069r5.html)
* OGC API - Features - Part 2: Coordinate Reference Systems by Reference
* [Version 1.0.1 (latest approved version)](https://docs.ogc.org/is/18-058r1/18-058r1.html)
* [Editor's draft (includes errata and clarifications)](https://docs.ogc.org/DRAFTS/18-058r2.html)
* OGC API - Features - Part 3: Filtering
* [Version 1.0.0 (latest approved version)](https://docs.ogc.org/is/19-079r2/19-079r2.html)
* [Editor's draft (includes errata and clarifications)](https://docs.ogc.org/DRAFTS/19-079r3.html)
Those who want to just see the endpoints and responses can explore [examples of
OpenAPI definitions](https://github.com/opengeospatial/ogcapi-features/tree/master/core/examples/openapi).
The reference version of the OpenAPI components and XML schemas are published
in the [OGC schema repository](http://schemas.opengis.net/ogcapi/features/).
Closely related is the Common Query Language (CQL2) standard:
* Common Query Language (CQL2)
* [Version 1.0.0 (latest approved version)](https://docs.ogc.org/is/21-065r2/21-065r2.html)
* [Editor's draft (includes errata and clarifications)](https://docs.ogc.org/DRAFTS/21-065r3.html)
## Server and client implementations
[Overview of tools implementing OGC API Features](implementations/README.adoc)
* [Server implementations - examples, more information and how-to guides](implementations/servers/README.md)
* [Client implementations - examples, more information and how-to guides](implementations/clients/README.md)
To test APIs, the following resources are available:
* [OGC Validator (by OGC)](https://cite.opengeospatial.org/teamengine/)
* [OGC Checker (by Geonovum)](https://geonovum-labs.github.io/ogc-checker/?#/ogc-api)
The OGC Validator is approved by the OGC Membership and is also used in the [OGC Compliance Program](https://cite.opengeospatial.org/) to certify software products implementing OGC API Features. It currently tests against version 1.0.0 of Part 1 and Part 2.
The OGC Checker requests the Landing Page, Conformance Declaration and API Definition. Tests are mainly executed against the API Definition. It currently tests against version 1.0.1 of Part 1.
### OGC Product Database
OGC maintains a public database of software products implementing approved OGC standards. The database also identifies products that pass the [OGC Compliance Test](https://www.ogc.org/compliance) for the standard, where available.
Implementers of OGC standards are encouraged to register their products in the database.
* OGC API - Features - Part 1: Core 1.0 ([All Products](https://www.ogc.org/resource/products?display_opt=3&specid=1022), [Compliant Products](https://www.ogc.org/resource/products?display_opt=1&specid=1022), [Reference Implementations](https://www.ogc.org/resource/products?display_opt=2&specid=1022))
* OGC API - Features - Part 2: Coordinate Reference Systems by Reference 1.0 ([All Products](https://www.ogc.org/resource/products?display_opt=3&specid=1121), [Compliant Products](https://www.ogc.org/resource/products?display_opt=1&specid=1121), [Reference Implementations](https://www.ogc.org/resource/products?display_opt=2&specid=1121))
## Communication
Join the [mailing list](https://lists.ogc.org/mailman/listinfo/wfs-fes.swg) or [](https://gitter.im/opengeospatial/WFS_FES?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Most all work on the specification takes place in [GitHub issues](https://github.com/opengeospatial/ogcapi-features/issues),
so browse there to get a good idea of what is happening, as well as past decisions.
## Additional parts of OGC API - Features
The OGC Features API SWG has identified the following extensions as the highest priority:
* [OGC API - Features - Part 4: Create, Replace, Update and Delete](https://docs.ogc.org/DRAFTS/20-002r1.html)
* The draft is complete and in the Public Comment Period.
* [OGC API - Features - Part 5: Schemas](https://docs.ogc.org/DRAFTS/23-058r1.html)
* The draft is complete and in the Public Comment Period.
* [OGC API - Features - Part 6: Property Selection](https://docs.ogc.org/DRAFTS/24-019.html)
* The draft is an initial, complete draft.
* [OGC API - Features - Part 7: Geometry Simplification](https://docs.ogc.org/DRAFTS/24-020.html)
* The draft is an initial, complete draft.
* [OGC API - Features - Part 8: Sorting](https://docs.ogc.org/DRAFTS/24-030.html)
* The draft is an initial, complete draft.
* [OGC API - Features - Part 9: Text Search](https://docs.ogc.org/DRAFTS/24-031.html)
* The draft is an initial, complete draft.
## OGC API Features in ISO
Part 1 (Core) has been published by ISO as [ISO 19168-1:2020](https://www.iso.org/standard/32586.html).
Part 2 (Coordinate Reference Systems by Reference) has been published by ISO as [ISO 19168-2:2022](https://www.iso.org/standard/82464.html).
## Additional information
Open issues for all parts are organized in [GitHub projects](https://github.com/opengeospatial/ogcapi-features/projects?query=is%3Aopen):
* [Open issues for Part 1: Core](https://github.com/orgs/opengeospatial/projects/18),
* [Open issues for Part 2: Coordinate Reference Systems by Reference](https://github.com/orgs/opengeospatial/projects/19)
* [Open issues for Part 3: Filtering / Common Query Language (CQL2)](https://github.com/orgs/opengeospatial/projects/20)
* [Open issues for Part 4: Create, Replace, Update and Delete](https://github.com/orgs/opengeospatial/projects/21)
* [Open issues for Part 5: Schemas](https://github.com/orgs/opengeospatial/projects/22)
* [Open issues for Part 6: Property Selection](https://github.com/orgs/opengeospatial/projects/17)
* [Open issues for Part 7: Geometry Simplification](https://github.com/orgs/opengeospatial/projects/23)
* [Open issues for Part 8: Sorting](https://github.com/orgs/opengeospatial/projects/24)
* [Open issues for Part 9: Text Search](https://github.com/orgs/opengeospatial/projects/25)
* [Open issues for Part 10: Search/Queries](https://github.com/orgs/opengeospatial/projects/26)
Additional links:
* [Background of this activity](docs/background.md)
* [The next version of WFS - an overview](docs/overview.md)
* [UML for Part 1, Core](docs/uml/README.md)
* [Status of Part 1, Core, in ISO](https://www.iso.org/standard/32586.html)
* [Home of the standard on the OGC website](https://www.ogc.org/standards/ogcapi-features)
## Building
The latest drafts of each standard in this repository are build daily (based on the configuration contained in the [asciidoctor.json](https://github.com/opengeospatial/ogcapi-features/blob/master/asciidoctor.json) file):
* [Part 1: Core](https://docs.ogc.org/DRAFTS/17-069r5.html)
* [Part 2: Coordinate Reference Systems by Reference](https://docs.ogc.org/DRAFTS/18-058r2.html)
* [Part 3: Filtering](https://docs.ogc.org/DRAFTS/19-079r3.html)
* [Part 4: Create, Replace, Update and Delete](https://docs.ogc.org/DRAFTS/20-002r1.html)
* [Part 5: Schemas](https://docs.ogc.org/DRAFTS/23-058r1.html)
* [Part 6: Property Selection](https://docs.ogc.org/DRAFTS/24-019.html)
* [Part 7: Geometry Simplification](https://docs.ogc.org/DRAFTS/24-020.html)
* [Part 8: Sorting](https://docs.ogc.org/DRAFTS/24-030.html)
* [Part 9: Text Search](https://docs.ogc.org/DRAFTS/24-031.html)
* [Common Query Language (CQL2)](https://docs.ogc.org/DRAFTS/21-065r3.html)
To generate the HTML versions of the standards from this repository yourself, ensure that you have [Ruby](https://www.ruby-lang.org/en/) and
[Asciidoctor](https://asciidoctor.org/) set up and [installed](https://asciidoctor.org/docs/#get-started-with-asciidoctor).
Then run:
```text
# Part 1: Core
asciidoctor -a data-uri -r asciidoctor-diagram core/standard/17-069.adoc
# Part 2: Coordinate Reference Systems by Reference
asciidoctor -a data-uri -r asciidoctor-diagram extensions/crs/standard/18-058.adoc
# Part 3: Filtering
asciidoctor -a data-uri -r asciidoctor-diagram extensions/filtering/standard/19-079.adoc
# Common Query Language (CQL2)
asciidoctor -a data-uri -r asciidoctor-diagram cql2/standard/21-065.adoc
# Part 4: Create, Replace, Update and Delete
asciidoctor -a data-uri -r asciidoctor-diagram extensions/transactions/create-replace-update-delete/standard/20-002.adoc
# Part 5: Schemas
asciidoctor extensions/schemas/standard/23-058.adoc
# Part 6: Property Selection
asciidoctor extensions/property-selection/standard/24-019.adoc
# Part 7: Geometry Simplification
asciidoctor extensions/geometry-simplification/standard/24-020.adoc
# Part 8: Sorting
asciidoctor extensions/sorting/standard/24-030.adoc
# Part 9: Text Search
asciidoctor extensions/text-search/standard/24-031.adoc
```
The resulting HTML files will be built in the same directory as the AsciiDoc file, e.g. as `core/standard/17-069.html`.
## [Contributing](CONTRIBUTING.md)
The contributor understands that any contributions, if accepted by the OGC Membership and ISO/TC 211, shall be incorporated into OGC and ISO/TC 211 OGC API standards documents and that all copyright and intellectual property shall be vested to the OGC.
The Features API Standards Working Group (SWG) is the group at OGC responsible for the stewardship of the standard, but is working to do as much work in public as possible.
* [Features API Standards Working Group Charter](CHARTER.adoc)
* [Open issues](https://github.com/opengeospatial/ogcapi-features/issues)
* [Proposing changes](https://github.com/opengeospatial/ogcapi-features/wiki/Propose-a-change-to-a-draft-of-a-specification-document)
* [Copy of License Language](https://raw.githubusercontent.com/opengeospatial/ogcapi-features/master/LICENSE)
Pull Requests from contributors are welcomed. However, please note that by sending a Pull Request or Commit to this GitHub repository, you are agreeing to the terms in the Observer Agreement https://portal.ogc.org/files/?artifact_id=92169