OGC API - Features¶

Capabilities¶

The service is self described using:

• html: A collection of web pages, with links for navigation between content (and that can be indexed by search engines for discoverability).

  

• application/json: A collection of json documents, with reference between each document for programmatic access by web developers.

  {
    "title": "GeoServer Web Feature Service",
    "description": "This is the reference implementation of WFS 1.0.0 and WFS 1.1.0, supports all WFS operations including Transaction.",
    "links": [
      {
        "href": "http://localhost:8080/geoserver/ogc/features/?f=application%2Fx-yaml",
        "rel": "alternate",
        "type": "application/x-yaml",
        "title": "This document as application/x-yaml"
      },
      {
        "href": "http://localhost:8080/geoserver/ogc/features/?f=application%2Fjson",
        "rel": "self",
        "type": "application/json",
        "title": "This document"
      },
      {
        "href": "http://localhost:8080/geoserver/ogc/features/?f=text%2Fhtml",
        "rel": "alternate",
        "type": "text/html",
        "title": "This document as text/html"
      }
  

• application/x-yaml: A collection of yaml documents, with references between each document for programmatic access.

  title: GeoServer Web Feature Service
  description: This is the reference implementation of WFS 1.0.0 and WFS 1.1.0, supports
    all WFS operations including Transaction.
  links:
  - href: http://localhost:8080/geoserver/ogc/features/?f=application%2Fx-yaml
    rel: self
    type: application/x-yaml
    title: This document
  - href: http://localhost:8080/geoserver/ogc/features/?f=application%2Fjson
    rel: alternate
    type: application/json
    title: This document as application/json
  - href: http://localhost:8080/geoserver/ogc/features/?f=text%2Fhtml
    rel: alternate
    type: text/html
    title: This document as text/html
  

The service title and description are provided by the existing Web Feature Service (WFS) settings.

Open API¶

For programmatic access an OpenAPI description of the service is provided, that may be browsed as documentation, or used to generate a client to access the web services.

Collections¶

The collection of feature types being published by the service.

Each collection entry is described using the layer details of title, description, geographic extent.

Data can be browsed as web pages, or downloaded in a range of formats such as GeoJSON and GML documents.

Conformance¶

Lists the operations this service can perform, each “conformance class” documents supported functionality.

Contact information¶

Advertises contact information for the service.

Defined by defined in by Contact Information.

HTML Templates¶

To override an OGC API Features template:

1. Create a directory ogc/features in the location you wish to override:

   • GEOSERVER_DATA_DIR/templates/ogc/features/v1

   • GEOSERVER_DATA_DIR/workspace/workspace/ogc/features/v1

   • GEOSERVER_DATA_DIR/workspace/workspace/datastore/ogc/features/v1

   • GEOSERVER_DATA_DIR/workspace/workspace/datastore/featuretype/ogc/features/v1

2. Create a file in this location, using the GeoServer 2.27-SNAPSHOT examples below:

   • ogc/features/v1/collection.ftl

   • ogc/features/v1/collection_include.ftl

   • ogc/features/v1/collections.ftl

   • ogc/features/v1/queryables.ftl

   • ogc/features/v1/functions.ftl

   The above built-in examples are for GeoServer 2.27-SNAPSHOT, please check for any changes when upgrading GeoServer.

The templates for listing feature content are shared between OGC API services. To override a template used to list features:

1. Use the directory in the location you wish to override:

   • GEOSERVER_DATA_DIR/templates

   • GEOSERVER_DATA_DIR/workspace/workspace

   • GEOSERVER_DATA_DIR/workspace/workspace/datastore

   • GEOSERVER_DATA_DIR/workspace/workspace/datastore/featuretype

   • ogc/features/landingPage.ftl

2. Create a file in this location, using the GeoServer 2.27-SNAPSHOT examples below:

   • ogc/features/getfeature-complex-content.ftl

   • ogc/features/getfeature-content.ftl

   • ogc/features/getfeature-empty.ftl

   • ogc/features/getfeature-footer.ftl

   • ogc/features/getfeature-header.ftl

   The above built-in examples are for GeoServer 2.27-SNAPSHOT, please check for any changes when upgrading GeoServer.

As an example customize how collections are listed:

1. The file ogc/features/collections.ftl lists published collection:

   <#global pagecrumbs>
     <li class='breadcrumb-item'><a href='${serviceLink("")}'>Home</a></li>
     <li class='breadcrumb-item active'>Collections</li>
   </#global>
   <#include "common-header.ftl">
   
     <h1>GeoServer Feature Collections</h1>
     <p class="my-4">
       This document lists all the collections available in the Features service.<br/>
     </p>
     
     <div class="row">
       <#list model.collections as collection>
       <div class="col-xs-12 col-md-6 col-lg-4 pb-4">
         <div class="card h-100">
           <div class="card-header">
             <h2><a href="${serviceLink("collections/${collection.id}")}">${collection.id}</a></h2>
           </div>
           <#include "collection_include.ftl">
         </div>
       </div>
       </#list>
     </div>
   
     <script src="${resourceLink('webresources/ogcapi/features.js')}"></script>
     <input type="hidden" id="maxNumberOfFeaturesForPreview" value="${service.maxNumberOfFeaturesForPreview}"/>
   
   <#include "common-footer.ftl">
   

2. Save file to GEOSERVER_DATA_DIR/workspace/templates/ogc/collections.ftl, and rewrite as:

   <#include "common-header.ftl">
          <h2>OGC API Feature Collections</h2>
          <p>List of collections published.</p>
          <p>See also: <#list model.getLinksExcept(null, "text/html") as link>
             <a href="${link.href}">${link.type}</a><#if link_has_next>, </#if></#list>.</p>
   
        <#list model.collections as collection>
          <h2><a href="${serviceLink("collections/${collection.id}")}">${collection.id}</a></h2>
          <#include "collection_include.ftl">
        </#list>
   <#include "common-footer.ftl">
   

3. Many templates are constructed using #include, for example collection.ftl above uses <#include "common-header.ftl"> located next to collections.ftl.

   Presently each family of templates manages its own common-header.ftl (as shown in the difference between ogc/features service templates, and getfeature templates above).

4. A restart is required, as templates are cached.

   

5. Language codes are appended for internationalization. For French create the file GEOSERVER_DATA_DIR/workspace/workspace/ogc/collections_fr.ftl and translate contents:

   <#include "common-header.ftl">
          <h2>OGC API Feature Service</h2>
          <p>Liste des collections publiées.</p>
          <p>Voir également: <#list model.getLinksExcept(null, "text/html") as link>
             <a href="${link.href}">${link.type}</a><#if link_has_next>, </#if></#list>.</p>
   
        <#list model.collections as collection>
          <h2><a href="${serviceLink("collections/${collection.id}")}">${collection.id}</a></h2>
          <#include "collection_include.ftl">
        </#list>
   <#include "common-footer.ftl">
   

6. For details on how to write templates see Freemarker Templates tutorial.

The following functions are specific to OGC API templates:

• serviceLink(path*, format) generates a link back to the same service. The first argument, mandatory, is the extra path after the service landing page, the second argument, optional, is the format to use for the link.

• genericServiceLink(path*, k1, v1, k2, v2, ....) generates a link back to any GeoServer OGC service, with additional query parameters. The first argument, mandatory, is the extra path after the GeoServer context path (usually /geoserver), the following arguments are key-value pairs to be added as query parameters to the link.

• resourceLink(path) links to a static resource, such as a CSS file or an image. The argument is the path to the resource, relative to the GeoServer context path (usually /geoserver).