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. arguments:
  46. - '@jsonapi.normalization_cacher'
  47. - '@event_dispatcher'
  48. - '@entity_field.manager'
  49. - '@entity_type.manager'
  50. tags:
  51. - { name: jsonapi_normalizer }
  52. jsonapi.normalization_cacher:
  53. class: Drupal\jsonapi\EventSubscriber\ResourceObjectNormalizationCacher
  54. calls:
  55. - ['setVariationCache', ['@variation_cache.jsonapi_normalizations']]
  56. - ['setRequestStack', ['@request_stack']]
  57. serializer.normalizer.content_entity.jsonapi:
  58. class: Drupal\jsonapi\Normalizer\ContentEntityDenormalizer
  59. tags:
  60. - { name: jsonapi_normalizer }
  61. serializer.normalizer.config_entity.jsonapi:
  62. class: Drupal\jsonapi\Normalizer\ConfigEntityDenormalizer
  63. tags:
  64. - { name: jsonapi_normalizer }
  65. serializer.normalizer.jsonapi_document_toplevel.jsonapi:
  66. class: Drupal\jsonapi\Normalizer\JsonApiDocumentTopLevelNormalizer
  67. tags:
  68. - { name: jsonapi_normalizer }
  69. serializer.normalizer.link_collection.jsonapi:
  70. class: Drupal\jsonapi\Normalizer\LinkCollectionNormalizer
  71. tags:
  72. - { name: jsonapi_normalizer }
  73. serializer.normalizer.relationship.jsonapi:
  74. class: Drupal\jsonapi\Normalizer\RelationshipNormalizer
  75. tags:
  76. - { name: jsonapi_normalizer }
  77. serializer.encoder.jsonapi:
  78. class: Drupal\jsonapi\Encoder\JsonEncoder
  79. tags:
  80. - { name: jsonapi_encoder, format: 'api_json' }
  81. jsonapi.resource_type.repository:
  82. class: Drupal\jsonapi\ResourceType\ResourceTypeRepository
  83. arguments: ['@entity_type.manager', '@entity_type.bundle.info', '@entity_field.manager', '@cache.jsonapi_resource_types', '@event_dispatcher']
  84. Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface: '@jsonapi.resource_type.repository'
  85. jsonapi.route_enhancer:
  86. class: Drupal\jsonapi\Routing\RouteEnhancer
  87. tags:
  88. - { name: route_enhancer }
  89. jsonapi.field_resolver:
  90. class: Drupal\jsonapi\Context\FieldResolver
  91. Drupal\jsonapi\Context\FieldResolver: '@jsonapi.field_resolver'
  92. jsonapi.include_resolver:
  93. class: Drupal\jsonapi\IncludeResolver
  94. Drupal\jsonapi\IncludeResolver: '@jsonapi.include_resolver'
  95. paramconverter.jsonapi.entity_uuid:
  96. parent: paramconverter.entity
  97. class: Drupal\jsonapi\ParamConverter\EntityUuidConverter
  98. calls:
  99. - [setLanguageManager, ['@language_manager']]
  100. tags:
  101. # Priority 10, to ensure it runs before @paramconverter.entity.
  102. - { name: paramconverter, priority: 10 }
  103. paramconverter.jsonapi.resource_type:
  104. class: Drupal\jsonapi\ParamConverter\ResourceTypeConverter
  105. tags:
  106. - { name: paramconverter }
  107. jsonapi.exception_subscriber:
  108. class: Drupal\jsonapi\EventSubscriber\DefaultExceptionSubscriber
  109. arguments: ['@jsonapi.serializer', '%serializer.formats%']
  110. logger.channel.jsonapi:
  111. parent: logger.channel_base
  112. arguments: ['jsonapi']
  113. # Cache.
  114. cache.jsonapi_memory:
  115. class: Drupal\Core\Cache\MemoryCache\MemoryCacheInterface
  116. tags:
  117. - { name: cache.bin.memory, default_backend: cache.backend.memory.memory }
  118. factory: ['@cache_factory', 'get']
  119. arguments: [jsonapi_memory]
  120. # A chained cache with an in-memory cache as the first layer and a database-
  121. # backed cache as the fallback is used. The first layer (memory) is necessary
  122. # because ResourceType value objects are retrieved many times during a
  123. # request. The second layer (by default a database) is necessary to avoid
  124. # recomputing the ResourceType value objects on every request.
  125. cache.jsonapi_resource_types:
  126. class: Drupal\Core\Cache\BackendChain
  127. calls:
  128. - [appendBackend, ['@cache.jsonapi_memory']]
  129. - [appendBackend, ['@cache.default']]
  130. tags: [{ name: cache.bin.memory }]
  131. cache.jsonapi_normalizations:
  132. class: Drupal\Core\Cache\CacheBackendInterface
  133. tags:
  134. - { name: cache.bin }
  135. factory: ['@cache_factory', 'get']
  136. arguments: [jsonapi_normalizations]
  137. variation_cache.jsonapi_normalizations:
  138. class: Drupal\Core\Cache\VariationCacheInterface
  139. factory: ['@variation_cache_factory', 'get']
  140. arguments: [jsonapi_normalizations]
  141. # Route filter.
  142. jsonapi.route_filter.format_setter:
  143. class: Drupal\jsonapi\Routing\EarlyFormatSetter
  144. tags:
  145. # Set to a high priority so it runs before content_type_header_matcher
  146. # and other filters that might throw exceptions.
  147. - { name: route_filter, priority: 100 }
  148. # Access Control
  149. jsonapi.entity_access_checker:
  150. class: Drupal\jsonapi\Access\EntityAccessChecker
  151. public: false
  152. arguments: ['@jsonapi.resource_type.repository', '@router.no_access_checks', '@current_user', '@entity.repository']
  153. calls:
  154. # This is a temporary measure. JSON:API should not need to be aware of the Content Moderation module.
  155. - [setLatestRevisionCheck, ['@?access_check.latest_revision']] # This is only injected when the service is available.
  156. Drupal\jsonapi\Access\EntityAccessChecker: '@jsonapi.entity_access_checker'
  157. access_check.jsonapi.relationship_route_access:
  158. class: Drupal\jsonapi\Access\RelationshipRouteAccessCheck
  159. tags:
  160. - { name: access_check, applies_to: _jsonapi_relationship_route_access }
  161. # Route filters.
  162. method_filter.jsonapi:
  163. public: false
  164. class: Drupal\jsonapi\Routing\ReadOnlyModeMethodFilter
  165. decorates: method_filter
  166. arguments: ['@method_filter.jsonapi.inner', '@config.factory']
  167. # Controller.
  168. jsonapi.entity_resource:
  169. class: Drupal\jsonapi\Controller\EntityResource
  170. arguments:
  171. - '@entity_type.manager'
  172. - '@entity_field.manager'
  173. - '@jsonapi.resource_type.repository'
  174. - '@renderer'
  175. - '@entity.repository'
  176. - '@jsonapi.include_resolver'
  177. - '@jsonapi.entity_access_checker'
  178. - '@jsonapi.field_resolver'
  179. - '@jsonapi.serializer'
  180. - '@datetime.time'
  181. - '@current_user'
  182. - '@event_dispatcher'
  183. Drupal\jsonapi\Controller\EntityResource: '@jsonapi.entity_resource'
  184. jsonapi.file_upload:
  185. class: Drupal\jsonapi\Controller\FileUpload
  186. Drupal\jsonapi\Controller\FileUpload: '@jsonapi.file_upload'
  187. # Event subscribers.
  188. jsonapi.custom_query_parameter_names_validator.subscriber:
  189. class: Drupal\jsonapi\EventSubscriber\JsonApiRequestValidator
  190. jsonapi.resource_response.subscriber:
  191. class: Drupal\jsonapi\EventSubscriber\ResourceResponseSubscriber
  192. arguments: ['@jsonapi.serializer']
  193. jsonapi.maintenance_mode_subscriber:
  194. class: Drupal\jsonapi\EventSubscriber\JsonapiMaintenanceModeSubscriber
  195. # Revision management.
  196. jsonapi.version_negotiator:
  197. class: Drupal\jsonapi\Revisions\VersionNegotiator
  198. public: false
  199. tags:
  200. - { name: service_collector, tag: jsonapi_version_negotiator, call: addVersionNegotiator }
  201. Drupal\jsonapi\Revisions\VersionNegotiator: '@jsonapi.version_negotiator'
  202. jsonapi.version_negotiator.default:
  203. public: false
  204. abstract: true
  205. jsonapi.version_negotiator.id:
  206. class: Drupal\jsonapi\Revisions\VersionById
  207. parent: jsonapi.version_negotiator.default
  208. tags:
  209. - { name: jsonapi_version_negotiator, negotiator_name: 'id' }
  210. jsonapi.version_negotiator.rel:
  211. class: Drupal\jsonapi\Revisions\VersionByRel
  212. parent: jsonapi.version_negotiator.default
  213. tags:
  214. - { name: jsonapi_version_negotiator, negotiator_name: 'rel' }
  215. jsonapi.resource_version.route_enhancer:
  216. class: Drupal\jsonapi\Revisions\ResourceVersionRouteEnhancer
  217. public: false
  218. tags:
  219. - { 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.