tsega/d8-site-api-key

Adds Site API Key to the Site Information form.

Background Information

When logged in as the administrator, the "Site Information" form can be found at the path /admin/config/system/site-information.

Requirements

This module needs to alter the existing Drupal "Site Information" form. Specifics:

• A new form text field named "Site API Key" needs to be added to the "Site Information" form with the default value of “No API Key yet”.
• When this form is submitted, the value that the user entered for this field should be saved as the system variable named "siteapikey".
• A Drupal message should inform the user that the Site API Key has been saved with that value.
• When this form is visited after the "Site API Key" is saved, the field should be populated with the correct value.
• The text of the "Save configuration" button should change to "Update Configuration".
• This module also provides a URL that responds with a JSON representation of a given node with the content type "page" only if the previously submitted API Key and a node id (nid) of an appropriate node are present, otherwise it will respond with "access denied".

Example URL

http://localhost/page_json/FOOBAR12345/17

Resources

• Creating custom modules
• A practical guide to building basic Drupal 8 modules
• Drupal coding standards
• Acquia Drupal 8 Module Development
• Drupal Exchange - How can I add a textbox in Site Information configuration
• Drupal 8 node serialization to JSON
• Using parameters in routes

Time Taken

The approximate time taken to implement this module was 5 hours. Note: It was my first time to build a Drupal 8 module.

d8-site-api-key's Issues

Change button label

The text of the "Save configuration" button should change to "Update Configuration".

Node JSON Representation

This module also provides a URL that responds with a JSON representation of a given node with the content type "page" only if the previously submitted API Key and a node id (nid) of an appropriate node are present, otherwise it will respond with "access denied".

Example:

http://localhost/page_json/FOOBAR12345/17

Save new field into database

When this form is submitted, the value that the user entered for this field should be saved as the system variable named "siteapikey".

Show value on re-visit

When this form is visited after the "Site API Key" is saved, the field should be populated with the correct value.

Drupal message on save/edit

A Drupal message should inform the user that the Site API Key has been saved with that value.

New Field in Site Information

A new form text field named "Site API Key" needs to be added to the "Site Information" form with the default value of “No API Key yet”.