この規格 プレビューページの目次
※一部、英文及び仏文を自動翻訳した日本語訳を使用しています。
序章
OGC API 標準[ 9] は、一貫した方法で Web API を空間的に有効にするためのモジュラー API ビルディング ブロックを定義します。 OpenAPI 仕様は、API ビルディング ブロックの定義に使用されます。
標準の OGC API ファミリは、リソース タイプ別に編成されています。このドキュメントでは、機能を操作するための基本的な API ビルディング ブロックを指定します。空間データ コミュニティでは、現実世界で関心のあるものに対して「フィーチャ」という用語を使用しています。
「機能」という用語に慣れていない場合は、W3C/OGC Spatial Data on the Web Best Practice ドキュメントの Spatial Things, Features, Geometry に関する説明で詳細を説明しています。
OGC API Features は、Web 上の機能を作成、変更、およびクエリするための API ビルディング ブロックを提供します。 OGC API 機能は複数の部分で構成されており、それぞれが個別の標準になっています。このドキュメント「コア」は、コア機能を指定し、ジオメトリが座標参照系 WGS 84 で表されるフィーチャwhere フェッチに限定され、軸の順序は経度/緯度です。より高度なニーズに対応する追加機能は、追加部分で指定されます。例としては、フィーチャの作成と変更、より複雑なデータ モデル、豊富なクエリ、追加の座標参照システム、複数のデータセット、およびコレクション階層のサポートが含まれます。
デフォルトでは、このドキュメントを実装するすべての API は、単一のデータセットへのアクセスを提供します。 OGC API 機能標準は、データを完全なデータセットとして共有するのではなく、機能 (オブジェクト) レベルでデータへの直接的できめ細かいアクセスを提供します。
このドキュメントで指定されている API ビルディング ブロックは、Web のアーキテクチャと一致しています。特に、API 設計は、IETF HTTP/HTTPS RFC, Web 上の W3C データのベスト プラクティス、Web 上の W3C/OGC 空間データのベスト プラクティス、および新しい OGC Web API ガイドラインによってガイドされています。特定の例は、DCAT で定義され、schema.org で使用されているデータセットおよびデータセット配布の概念の使用です。
このドキュメントでは、HTTP GET メソッドを使用して実装される検出およびクエリ操作を指定します。追加のメソッド (特に POST, PUT, DELETE, PATCH) のサポートは、追加の部分で指定されます。
検出操作により、クライアントは、API によって提供される機能コレクションに関する API 定義とメタデータを含む API に問い合わせて、API の機能を判断し、データセットの利用可能なディストリビューションに関する情報を取得できます。
クエリ操作により、クライアントは、クライアントが定義した単純な選択基準に基づいて、基になるデータ ストアからフィーチャを取得できます。
標準の OGC API ファミリのサブセットは、ISO によって公開される予定です。たとえば、この文書は ISO 19168-1 として ISO によって公開されています。 OGC API 標準のサブセットのみが ISO によって公開されることを反映し、ISO 標準のタイトルに組織名を使用しないようにするために、「OGC API」シリーズの標準は、ISO によって「地理空間 API」、つまりタイトルとして公開されます。 OGC でのこのドキュメントのタイトルは「OGC API — 機能 — Part 1: コア」であり、ISO でのタイトルは「地理情報 — 機能のための地理空間 API — Part 1: コア」です。
簡単にするために、このドキュメントでは一貫して以下を使用します。
- 「OGC API」は、ISO で「Geospatial API」として公開されている地理空間 Web API の標準ファミリを指します。
- 「OGC API - 機能」は、ISO で ISO 19168/「地理情報 - 機能の地理空間 API」として公開されている機能のマルチパート標準を参照します。
- 「OGC API - 機能 - Part 1: コア」は、ISO で ISO 19168-1/「地理情報 - 機能の地理空間 API - Part 1: コア」として公開されているこのドキュメントを参照するために使用されます。
このドキュメントでは、表 1 に示すリソースを定義します。リソースの概要については、7.1 を参照してください。
表 1 —リソース、適用可能な HTTP メソッド、およびドキュメント セクションへのリンクの概要
| 資力 | 道 | HTTP 方法 | ドキュメント参照 |
|---|---|---|---|
| ランディングページ | / | 得る | 7.2 API ランディング ページ |
| 適合性 宣言 | /適合性 | 得る | 7.4 適合クラスの宣言 |
| 機能コレクション | /コレクション | 得る | 7.13 機能コレクション |
| 機能コレクション | /collections/{collectionId} | 得る | 7.14 特徴集 |
| 特徴 | /collections/{collectionId}/items | 得る | 7.15 機能 |
| 特徴 | /collections/{collectionId}/items/{featureId} | 得る | 7.16 機能 |
OGC API 機能の実装は、クライアントが API を使用する方法について 2 つの異なるアプローチをサポートすることを目的としています。詳細については、6.1 を参照してください。
Introduction
OGC API standards[9] define modular API building blocks to spatially enable Web APIs in a consistent manner. The OpenAPI specification is used to define the API building blocks.
The OGC API family of standards is organized by resource type. This document 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.
For those not familiar with the term 'feature,' the explanations on Spatial Things, Features and Geometry in the W3C/OGC Spatial Data on the Web Best Practice document provide more detail.
OGC API Features provides API building blocks to create, modify and query features on the Web. OGC API Features is comprised of multiple parts, each of them a separate standard. This document, the"Core", specifies the core capabilities and is restricted to fetching features where geometries are represented in the coordinate reference system, WGS 84, with axis order longitude/latitude. Additional capabilities that address more advanced needs will be specified in additional parts. Examples include support for creating and modifying features, more complex data models, richer queries, additional coordinate reference systems, multiple datasets and collection hierarchies.
By default, every API implementing this document will provide access to a single dataset. Rather than sharing the data as a complete dataset, the OGC API Features standards offer direct, fine-grained access to the data at the feature (object) level.
The API building blocks specified in this document are consistent with the architecture of the Web. In particular, the API design is guided by the IETF HTTP/HTTPS RFCs, the W3C Data on the Web Best Practices, the W3C/OGC Spatial Data on the Web Best Practices and the emerging OGC Web API Guidelines. A particular example is the use of the concepts of datasets and dataset distributions as defined in DCAT and used in schema.org.
This document specifies discovery and query operations that are implemented using the HTTP GET method. Support for additional methods (in particular POST, PUT, DELETE, PATCH) will be specified in additional parts.
Discovery operations enable clients to interrogate the API, including the API definition and metadata about the feature collections provided by the API, to determine the capabilities of the API and retrieve information about available distributions of the dataset.
Query operations enable clients to retrieve features from the underlying data store based upon simple selection criteria, defined by the client.
A subset of the OGC API family of standards is expected to be published by ISO. For example, this document is published by ISO as ISO 19168-1. To reflect that only a subset of the OGC API standards will be published by ISO and to avoid using organization names in the titles of ISO standards, standards from the"OGC API" series are published by ISO as"Geospatial API," i.e. the title of this document in OGC is"OGC API — Features — Part 1: Core" and the title in ISO is"Geographic Information — Geospatial API for features — Part 1: Core."
For simplicity, this document consistently uses:
- "OGC API" to refer to the family of standards for geospatial Web APIs that in ISO is published as"Geospatial API;"
- "OGC API - Features" to refer to the multipart standard for features that in ISO is published as ISO 19168/"Geographic Information - Geospatial API for features;"
- "OGC API - Features — Part 1: Core" to refer to this document that in ISO is published as ISO 19168-1/"Geographic Information - Geospatial API for features — Part 1: Core."
This document defines the resources listed in Table 1. For an overview of the resources, see 7.1.
Table 1 — Overview of resources, applicable HTTP methods and links to the document sections
| Resource | Path | HTTP method | Document reference |
|---|---|---|---|
| Landing page | / | GET | 7.2 API landing page |
| Conformance declaration | /conformance | GET | 7.4 Declaration of conformance classes |
| Feature collections | /collections | GET | 7.13 Feature collections |
| Feature collection | /collections/{collectionId} | GET | 7.14 Feature collection |
| Features | /collections/{collectionId}/items | GET | 7.15 Features |
| Feature | /collections/{collectionId}/items/{featureId} | GET | 7.16 Feature |
Implementations of OGC API Features are intended to support two different approaches for how clients can use the API. For further information, see 6.1.