この規格 プレビューページの目次
※一部、英文及び仏文を自動翻訳した日本語訳を使用しています。
導入
OGC API 標準[ 10] は、一貫した方法で Web API を空間的に有効にするためのモジュラー API ビルディング ブロックを定義しています。 OpenAPI 仕様は、API ビルディング ブロックを定義するために使用されます。
ISO は、標準の OGC API ファミリのサブセットを公開しました。 OGC API 標準のサブセットのみが ISO によって公開されることを反映し、ISO 標準のタイトルに組織名が使用されることを避けるために、「OGC API」シリーズの標準は ISO によって「Geospatial API」として公開されます。たとえば、OGC でのこのドキュメントのタイトルは「OGC API - 機能 - Part 1: コア」、ISO でのタイトルは「地理情報 - 機能用地理空間 API - Part 1: コア」です。
わかりやすくするために、このドキュメントでは一貫して以下を使用します。
- 「OGC API」は、ISO では「地理空間 API」として公開されている地理空間 Web API の標準ファミリーを指します。
- 「OGC API - 機能」とは、特定の部分が ISO 19168 シリーズ/「地理情報 - 機能用地理空間 API」として ISO によって公開されている機能のマルチパート標準を指します。そして
- 「このドキュメント」は「OGC API - 機能 - Part 1: コア」を指します。これは ISO 19168-1/「地理情報 - 機能用地理空間 API - Part 1: コア」として ISO によって発行されています。
OGC API はリソースの種類ごとに編成されています。 OGC API - 機能は、機能と対話するための基本的な API ビルディング ブロックを指定します。空間データ コミュニティでは、現実世界の関心のあるものに対して「フィーチャ」という用語が使用されます。
注「フィーチャ」という用語に馴染みのない人のために、W3C/OGC Spatial Data on the Web Best Practice 文書[ 7] の空間的なもの、フィーチャ、およびジオメトリに関する説明を参照してください。
OGC API - 機能は、Web 上で機能を作成、変更、クエリするための API ビルディング ブロックを提供します。このシリーズは複数の部分で構成されており、それぞれが個別の規格です。このドキュメント (ISO 19168-1) は、そのような部分の 1 つである「コア」に相当し、コア機能を指定し、ジオメトリが座標参照系 (CRS) WGS 84 で軸順序経度/軸順で表現されるフィーチャwhere フェッチに限定されます。緯度。より高度なニーズに対応する追加機能は、追加の部分で指定されます。例には、機能の作成と変更、より複雑なデータ モデル、より豊富なクエリ、追加の CRS, 複数のデータセット、コレクション階層のサポートが含まれます。
デフォルトでは、このドキュメントを実装するすべての API は、単一のデータセットへのアクセスを提供します。 OGC API - 機能は、データを完全なデータセットとして共有するのではなく、機能 (オブジェクト) レベルでのデータへの直接的かつきめ細かいアクセスを提供します。
このドキュメントで指定されている API ビルディング ブロックは、Web のアーキテクチャと一致しています。特に、API 設計は、IETF HTTP/HTTPS RFC, W3C Data on the Web Best Practices [ 8] 、W3C/OGC Spatial Data on the Web Best Practices [ 7] 、および新たな OGC Web API ガイドラインによって導かれています。 。特定の例は、DCAT [ 9] で定義され、 schema.org で使用されるデータセットとデータセット配布の概念の使用です。
この文書では、HTTP GET メソッドを使用して実装される検出およびクエリ操作を指定します。追加メソッド (特に POST, PUT, DELETE, PATCH) のサポートは、追加部分で指定されます。
ディスカバリ操作により、クライアントは API 定義や API が提供する機能コレクションに関するメタデータなどを API に問い合わせて、API の機能を判断し、利用可能なデータセットのディストリビューションに関する情報を取得できます。
クエリ操作を使用すると、クライアントは、クライアントが定義した単純な選択基準に基づいて、基礎となるデータ ストアから機能を取得できます。
この文書では、表 1 にリストされているリソースを定義します。リソースの概要については、7.1 を参照してください。
表 1 —リソースの概要、適用可能な HTTP メソッド、およびドキュメントのセクションへのリンク
| リソース | パス | HTTPメソッド | 副節 |
|---|---|---|---|
| ランディングページ | / | 得る | 7.2 API ランディング ページ |
| 適合宣言 | /適合 | 得る | 7.4 適合クラスの宣言 |
| 機能コレクション | /コレクション | 得る | 7.13 機能コレクション |
| 機能コレクション | /collections/{コレクションID} | 得る | 7.14 機能の収集 |
| 特徴 | /collections/{collectionId}/items | 得る | 7.15 機能 |
| 特徴 | /collections/{collectionId}/items/{featureId} | 得る | 7.16 機能 |
Introduction
OGC API standards[10] define modular API building blocks to spatially enable Web APIs in a consistent way. The OpenAPI specification is used to define the API building blocks.
ISO has published a subset of the OGC API family of standards. 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." For example, 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 of which certain parts are published by ISO as the ISO 19168 series/"Geographic Information — Geospatial API for Features"; and
- "this document" to refer to"OGC API - Features - Part 1: Core", which is published by ISO as ISO 19168-1/"Geographic Information — Geospatial API for Features — Part 1: Core".
OGC API 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.
NOTE 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[7] provide more detail.
OGC API - Features provides API building blocks to create, modify and query features on the Web. The series is comprised of multiple parts, each of them a separate standard. This document (ISO 19168-1), which corresponds to one such part, the"Core", specifies the core capabilities and is restricted to fetching features where geometries are represented in the coordinate reference system (CRS) 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 CRS, 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, OGC API - Features offers 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,[8] the W3C/OGC Spatial Data on the Web Best Practices,[7] 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[9] 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) is 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.
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 | Subclause |
|---|---|---|---|
| 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 |