add Accept header support

Author: tomkralidis

pygeoapi/api/__init__.py

@@ -320,11 +320,14 @@ def _get_locale(self, headers: dict,
 
         return raw, default_locale
 
-    def _get_format(self, headers: dict) -> Union[str, None]:
+    def _get_format(self, headers: dict,
+                    extra_formats: dict = {}) -> Union[str, None]:
         """
         Get `Request` format type from query parameters or headers.
 
         :param headers: Dict of Request headers
+        :param extra_formats: Dict of extra dataset specific formats
+
         :returns: format value or None if not found/specified
         """
 
@@ -340,10 +343,14 @@ def _get_format(self, headers: dict) -> Union[str, None]:
         if types_ is None:
             return
 
-        (fmts, mimes) = zip(*FORMAT_TYPES.items())
+        merged_format_types = FORMAT_TYPES | extra_formats
+
+        (fmts, mimes) = zip(*merged_format_types.items())
+        mimes2 = [m.split(';')[0] for m in mimes]
+
         for type_ in types_:
-            if type_ in mimes:
-                idx_ = mimes.index(type_)
+            if type_ in mimes2:
+                idx_ = mimes2.index(type_)
                 return fmts[idx_]
 
     @property

pygeoapi/api/itemtypes.py

@@ -354,6 +354,14 @@ def get_collection_items(
     LOGGER.debug('Validating requested format')
     dataset_formatters = get_dataset_formatters(collections[dataset])
 
+    if dataset_formatters:
+        LOGGER.debug(f'Dataset formatters: {dataset_formatters}')
+        request._format = request._get_format(
+            request.get_request_headers(request.headers),
+            {v.f: v.mimetype for v in dataset_formatters.values()})
+
+        LOGGER.debug(f'Request format: {request.format}')
+
     if not request.is_valid(dataset_formatters.keys()):
         return api.get_format_exception(request)
 

pygeoapi/formatter/base.py

@@ -45,6 +45,7 @@ def __init__(self, formatter_def: dict):
         """
 
         self.extension = None
+        self.f = None
         self.mimetype = None
 
         try:

tests/api/test_itemtypes.py

@@ -400,6 +400,23 @@ def test_get_collection_items(config, api_):
 
     assert code == HTTPStatus.BAD_REQUEST
 
+    # test Accept header for dataset formatters
+    req = mock_api_request(HTTP_ACCEPT='application/json')
+    rsp_headers, code, response = get_collection_items(api_, req, 'obs')
+    assert rsp_headers['Content-Type'] == 'application/json'
+
+    req = mock_api_request(HTTP_ACCEPT='text/csv')
+    rsp_headers, code, response = get_collection_items(api_, req, 'obs')
+    assert rsp_headers['Content-Type'] == 'text/csv; charset=utf-8'
+
+    req = mock_api_request({'f': 'json'}, HTTP_ACCEPT='text/csv')
+    rsp_headers, code, response = get_collection_items(api_, req, 'obs')
+    assert rsp_headers['Content-Type'] == 'application/json'
+
+    req = mock_api_request({'f': 'csv'}, HTTP_ACCEPT='application/json')
+    rsp_headers, code, response = get_collection_items(api_, req, 'obs')
+    assert rsp_headers['Content-Type'] == 'text/csv; charset=utf-8'
+
 
 def test_get_collection_items_include_extra_query_parameters(config, api_):
     req = mock_api_request()