JSON:API Basic Site Settings
This simple module created to provide key site settings to the frontend via JSON:API. It also has an API hook to add some additional information to data. After enabling module, you can open /jsonapi/site/site URL and read data. You must use key_auth authentication provided by Key Auth module, to prevent unauthorized access.
This module is needed for sites where the frontend is separated from the backend (the so-called decoupled sites), and eliminates the need for the frontend to obtain general data about the site:
- name => system.site.name
- mail => system.site.mail
- slogan => system.site.slogan
- page_front => system.site.page.front
- page_403 => system.site.page.403
- page_404 => system.site.page.404
- default_langcode => system.site.page.default_langcode
- default_theme => system.theme.default
- admin_theme => system.theme.admin
- global_logo => system.theme.global.logo.path
- global_favicon => system.theme.global.favicon.path
Also, you can add any additional information to JSON:API response via alter hook hook_jsonapi_site_data_alter(&$data):
function hook_jsonapi_site_data_alter(&$data) {
$data['additional'] = t('Some text');
}
In conjunction with JSON:API Extras module you can get a full API info for your backend.
Depends on
Dependencies of the latest stable release
No dependencies recorded for this project.
Required by
Tracked projects that depend on this one
No tracked projects depend on this one yet.
Activity
Releases
| Version | Type | Core | Release date | |
|---|---|---|---|---|
| 1.0.2 | Stable | May 5, 2024 |