jsonapi.services.yml

Same filename and directory in other branches
  1. 10 core/modules/jsonapi/jsonapi.services.yml
  2. 11.x core/modules/jsonapi/jsonapi.services.yml
  3. 9 core/modules/jsonapi/jsonapi.services.yml
  4. 8.9.x core/modules/jsonapi/jsonapi.services.yml
core/modules/jsonapi/jsonapi.services.yml

File

core/modules/jsonapi/jsonapi.services.yml

View source
  1. parameters:
  2. jsonapi.base_path: /jsonapi
  3. jsonapi.skip_procedural_hook_scan: true
  4. services:
  5. _defaults:
  6. autoconfigure: true
  7. autowire: true
  8. jsonapi.serializer:
  9. class: Drupal\jsonapi\Serializer\Serializer
  10. calls:
  11. - [setFallbackNormalizer, ['@serializer']]
  12. arguments: [{ }, { }]
  13. serializer.normalizer.http_exception.jsonapi:
  14. class: Drupal\jsonapi\Normalizer\HttpExceptionNormalizer
  15. tags:
  16. - { name: jsonapi_normalizer }
  17. serializer.normalizer.unprocessable_entity_exception.jsonapi:
  18. class: Drupal\jsonapi\Normalizer\UnprocessableHttpEntityExceptionNormalizer
  19. tags:
  20. # This must have a higher priority than the 'serializer.normalizer.http_exception.jsonapi' to take effect.
  21. - { name: jsonapi_normalizer, priority: 1 }
  22. serializer.normalizer.entity_access_exception.jsonapi:
  23. class: Drupal\jsonapi\Normalizer\EntityAccessDeniedHttpExceptionNormalizer
  24. tags:
  25. # This must have a higher priority than the 'serializer.normalizer.http_exception.jsonapi' to take effect.
  26. - { name: jsonapi_normalizer, priority: 1 }
  27. serializer.normalizer.field_item.jsonapi:
  28. class: Drupal\jsonapi\Normalizer\FieldItemNormalizer
  29. tags:
  30. - { name: jsonapi_normalizer }
  31. serializer.normalizer.field.jsonapi:
  32. class: Drupal\jsonapi\Normalizer\FieldNormalizer
  33. tags:
  34. - { name: jsonapi_normalizer }
  35. serializer.normalizer.resource_identifier.jsonapi:
  36. class: Drupal\jsonapi\Normalizer\ResourceIdentifierNormalizer
  37. tags:
  38. - { name: jsonapi_normalizer }
  39. serializer.normalizer.data.jsonapi:
  40. class: Drupal\jsonapi\Normalizer\DataNormalizer
  41. tags:
  42. - { name: jsonapi_normalizer }
  43. serializer.normalizer.resource_object.jsonapi:
  44. class: Drupal\jsonapi\Normalizer\ResourceObjectNormalizer
  45. tags:
  46. - { name: jsonapi_normalizer }
  47. jsonapi.normalization_cacher:
  48. class: Drupal\jsonapi\EventSubscriber\ResourceObjectNormalizationCacher
  49. calls:
  50. - ['setVariationCache', ['@variation_cache.jsonapi_normalizations']]
  51. - ['setRequestStack', ['@request_stack']]
  52. serializer.normalizer.content_entity.jsonapi:
  53. class: Drupal\jsonapi\Normalizer\ContentEntityDenormalizer
  54. tags:
  55. - { name: jsonapi_normalizer }
  56. serializer.normalizer.config_entity.jsonapi:
  57. class: Drupal\jsonapi\Normalizer\ConfigEntityDenormalizer
  58. tags:
  59. - { name: jsonapi_normalizer }
  60. serializer.normalizer.jsonapi_document_toplevel.jsonapi:
  61. class: Drupal\jsonapi\Normalizer\JsonApiDocumentTopLevelNormalizer
  62. tags:
  63. - { name: jsonapi_normalizer }
  64. serializer.normalizer.link_collection.jsonapi:
  65. class: Drupal\jsonapi\Normalizer\LinkCollectionNormalizer
  66. tags:
  67. - { name: jsonapi_normalizer }
  68. serializer.normalizer.relationship.jsonapi:
  69. class: Drupal\jsonapi\Normalizer\RelationshipNormalizer
  70. tags:
  71. - { name: jsonapi_normalizer }
  72. serializer.encoder.jsonapi:
  73. class: Drupal\jsonapi\Encoder\JsonEncoder
  74. tags:
  75. - { name: jsonapi_encoder, format: 'api_json' }
  76. jsonapi.resource_type.repository:
  77. class: Drupal\jsonapi\ResourceType\ResourceTypeRepository
  78. Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface: '@jsonapi.resource_type.repository'
  79. jsonapi.route_enhancer:
  80. class: Drupal\jsonapi\Routing\RouteEnhancer
  81. tags:
  82. - { name: route_enhancer }
  83. jsonapi.field_resolver:
  84. class: Drupal\jsonapi\Context\FieldResolver
  85. Drupal\jsonapi\Context\FieldResolver: '@jsonapi.field_resolver'
  86. jsonapi.include_resolver:
  87. class: Drupal\jsonapi\IncludeResolver
  88. Drupal\jsonapi\IncludeResolver: '@jsonapi.include_resolver'
  89. paramconverter.jsonapi.entity_uuid:
  90. parent: paramconverter.entity
  91. class: Drupal\jsonapi\ParamConverter\EntityUuidConverter
  92. calls:
  93. - [setLanguageManager, ['@language_manager']]
  94. tags:
  95. # Priority 10, to ensure it runs before @paramconverter.entity.
  96. - { name: paramconverter, priority: 10 }
  97. paramconverter.jsonapi.resource_type:
  98. class: Drupal\jsonapi\ParamConverter\ResourceTypeConverter
  99. tags:
  100. - { name: paramconverter }
  101. jsonapi.exception_subscriber:
  102. class: Drupal\jsonapi\EventSubscriber\DefaultExceptionSubscriber
  103. arguments: ['@jsonapi.serializer', '%serializer.formats%']
  104. logger.channel.jsonapi:
  105. parent: logger.channel_base
  106. arguments: ['jsonapi']
  107. # Cache.
  108. cache.jsonapi_memory:
  109. class: Drupal\Core\Cache\MemoryCache\MemoryCacheInterface
  110. tags:
  111. - { name: cache.bin.memory, default_backend: cache.backend.memory.memory }
  112. factory: ['@cache_factory', 'get']
  113. arguments: [jsonapi_memory]
  114. # A chained cache with an in-memory cache as the first layer and a database-
  115. # backed cache as the fallback is used. The first layer (memory) is necessary
  116. # because ResourceType value objects are retrieved many times during a
  117. # request. The second layer (by default a database) is necessary to avoid
  118. # recomputing the ResourceType value objects on every request.
  119. cache.jsonapi_resource_types:
  120. class: Drupal\Core\Cache\BackendChain
  121. calls:
  122. - [appendBackend, ['@cache.jsonapi_memory']]
  123. - [appendBackend, ['@cache.default']]
  124. tags: [{ name: cache.bin.memory }]
  125. cache.jsonapi_normalizations:
  126. class: Drupal\Core\Cache\CacheBackendInterface
  127. tags:
  128. - { name: cache.bin }
  129. factory: ['@cache_factory', 'get']
  130. arguments: [jsonapi_normalizations]
  131. variation_cache.jsonapi_normalizations:
  132. class: Drupal\Core\Cache\VariationCacheInterface
  133. factory: ['@variation_cache_factory', 'get']
  134. arguments: [jsonapi_normalizations]
  135. # Route filter.
  136. jsonapi.route_filter.format_setter:
  137. class: Drupal\jsonapi\Routing\EarlyFormatSetter
  138. tags:
  139. # Set to a high priority so it runs before content_type_header_matcher
  140. # and other filters that might throw exceptions.
  141. - { name: route_filter, priority: 100 }
  142. # Access Control
  143. jsonapi.entity_access_checker:
  144. class: Drupal\jsonapi\Access\EntityAccessChecker
  145. public: false
  146. calls:
  147. # This is a temporary measure. JSON:API should not need to be aware of the Content Moderation module.
  148. - [setLatestRevisionCheck, ['@?access_check.latest_revision']] # This is only injected when the service is available.
  149. Drupal\jsonapi\Access\EntityAccessChecker: '@jsonapi.entity_access_checker'
  150. access_check.jsonapi.relationship_route_access:
  151. class: Drupal\jsonapi\Access\RelationshipRouteAccessCheck
  152. tags:
  153. - { name: access_check, applies_to: _jsonapi_relationship_route_access }
  154. # Route filters.
  155. method_filter.jsonapi:
  156. public: false
  157. class: Drupal\jsonapi\Routing\ReadOnlyModeMethodFilter
  158. decorates: method_filter
  159. arguments: ['@method_filter.jsonapi.inner', '@config.factory']
  160. # Controller.
  161. jsonapi.entity_resource:
  162. class: Drupal\jsonapi\Controller\EntityResource
  163. Drupal\jsonapi\Controller\EntityResource: '@jsonapi.entity_resource'
  164. jsonapi.file_upload:
  165. class: Drupal\jsonapi\Controller\FileUpload
  166. Drupal\jsonapi\Controller\FileUpload: '@jsonapi.file_upload'
  167. # Event subscribers.
  168. jsonapi.custom_query_parameter_names_validator.subscriber:
  169. class: Drupal\jsonapi\EventSubscriber\JsonApiRequestValidator
  170. jsonapi.resource_response.subscriber:
  171. class: Drupal\jsonapi\EventSubscriber\ResourceResponseSubscriber
  172. jsonapi.maintenance_mode_subscriber:
  173. class: Drupal\jsonapi\EventSubscriber\JsonapiMaintenanceModeSubscriber
  174. # Revision management.
  175. jsonapi.version_negotiator:
  176. class: Drupal\jsonapi\Revisions\VersionNegotiator
  177. public: false
  178. tags:
  179. - { name: service_collector, tag: jsonapi_version_negotiator, call: addVersionNegotiator }
  180. Drupal\jsonapi\Revisions\VersionNegotiator: '@jsonapi.version_negotiator'
  181. jsonapi.version_negotiator.default:
  182. public: false
  183. abstract: true
  184. jsonapi.version_negotiator.id:
  185. class: Drupal\jsonapi\Revisions\VersionById
  186. parent: jsonapi.version_negotiator.default
  187. tags:
  188. - { name: jsonapi_version_negotiator, negotiator_name: 'id' }
  189. jsonapi.version_negotiator.rel:
  190. class: Drupal\jsonapi\Revisions\VersionByRel
  191. parent: jsonapi.version_negotiator.default
  192. tags:
  193. - { name: jsonapi_version_negotiator, negotiator_name: 'rel' }
  194. jsonapi.resource_version.route_enhancer:
  195. class: Drupal\jsonapi\Revisions\ResourceVersionRouteEnhancer
  196. public: false
  197. tags:
  198. - { name: route_enhancer }

Services

Title Deprecated Summary
access_check.jsonapi.relationship_route_access Drupal\jsonapi\Access\RelationshipRouteAccessCheck
cache.jsonapi_memory Drupal\Core\Cache\MemoryCache\MemoryCacheInterface
cache.jsonapi_normalizations Drupal\Core\Cache\CacheBackendInterface
cache.jsonapi_resource_types Drupal\Core\Cache\BackendChain
jsonapi.custom_query_parameter_names_validator.subscriber Drupal\jsonapi\EventSubscriber\JsonApiRequestValidator
jsonapi.entity_access_checker Drupal\jsonapi\Access\EntityAccessChecker
jsonapi.entity_resource Drupal\jsonapi\Controller\EntityResource
jsonapi.exception_subscriber Drupal\jsonapi\EventSubscriber\DefaultExceptionSubscriber
jsonapi.field_resolver Drupal\jsonapi\Context\FieldResolver
jsonapi.file_upload Drupal\jsonapi\Controller\FileUpload
jsonapi.include_resolver Drupal\jsonapi\IncludeResolver
jsonapi.maintenance_mode_subscriber Drupal\jsonapi\EventSubscriber\JsonapiMaintenanceModeSubscriber
jsonapi.normalization_cacher Drupal\jsonapi\EventSubscriber\ResourceObjectNormalizationCacher
jsonapi.resource_response.subscriber Drupal\jsonapi\EventSubscriber\ResourceResponseSubscriber
jsonapi.resource_type.repository Drupal\jsonapi\ResourceType\ResourceTypeRepository
jsonapi.resource_version.route_enhancer Drupal\jsonapi\Revisions\ResourceVersionRouteEnhancer
jsonapi.route_enhancer Drupal\jsonapi\Routing\RouteEnhancer
jsonapi.route_filter.format_setter Drupal\jsonapi\Routing\EarlyFormatSetter
jsonapi.serializer Drupal\jsonapi\Serializer\Serializer
jsonapi.version_negotiator Drupal\jsonapi\Revisions\VersionNegotiator
jsonapi.version_negotiator.default Abstract
jsonapi.version_negotiator.id Drupal\jsonapi\Revisions\VersionById
jsonapi.version_negotiator.rel Drupal\jsonapi\Revisions\VersionByRel
logger.channel.jsonapi
method_filter.jsonapi Drupal\jsonapi\Routing\ReadOnlyModeMethodFilter
paramconverter.jsonapi.entity_uuid Drupal\jsonapi\ParamConverter\EntityUuidConverter
paramconverter.jsonapi.resource_type Drupal\jsonapi\ParamConverter\ResourceTypeConverter
serializer.encoder.jsonapi Drupal\jsonapi\Encoder\JsonEncoder
serializer.normalizer.config_entity.jsonapi Drupal\jsonapi\Normalizer\ConfigEntityDenormalizer
serializer.normalizer.content_entity.jsonapi Drupal\jsonapi\Normalizer\ContentEntityDenormalizer
serializer.normalizer.data.jsonapi Drupal\jsonapi\Normalizer\DataNormalizer
serializer.normalizer.entity_access_exception.jsonapi Drupal\jsonapi\Normalizer\EntityAccessDeniedHttpExceptionNormalizer
serializer.normalizer.field.jsonapi Drupal\jsonapi\Normalizer\FieldNormalizer
serializer.normalizer.field_item.jsonapi Drupal\jsonapi\Normalizer\FieldItemNormalizer
serializer.normalizer.http_exception.jsonapi Drupal\jsonapi\Normalizer\HttpExceptionNormalizer
serializer.normalizer.jsonapi_document_toplevel.jsonapi Drupal\jsonapi\Normalizer\JsonApiDocumentTopLevelNormalizer
serializer.normalizer.link_collection.jsonapi Drupal\jsonapi\Normalizer\LinkCollectionNormalizer
serializer.normalizer.relationship.jsonapi Drupal\jsonapi\Normalizer\RelationshipNormalizer
serializer.normalizer.resource_identifier.jsonapi Drupal\jsonapi\Normalizer\ResourceIdentifierNormalizer
serializer.normalizer.resource_object.jsonapi Drupal\jsonapi\Normalizer\ResourceObjectNormalizer
serializer.normalizer.unprocessable_entity_exception.jsonapi Drupal\jsonapi\Normalizer\UnprocessableHttpEntityExceptionNormalizer
variation_cache.jsonapi_normalizations Drupal\Core\Cache\VariationCacheInterface
_defaults

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.