This project is not covered by Drupal’s security advisory policy.

WebAPI Starter is the plain Drupal API site template. It sets up a site that serves its content over JSON:API and documents it, and it adds nothing else.

What it builds

  • JSON:API served from an /api prefix.
  • Read-only by default, so the API answers GET requests and nothing can be written through it until you decide otherwise.
  • OAuth 2.0 for authentication and authorization.
  • Swagger UI documentation for the endpoints.
  • The Drupal core administration theme for the whole site, front end and back end.

All of it comes from the WebAPI module, which uses core JSON:API together with contributed modules from drupal.org. There is no content model: bring your own content types and they are served as they are.

Install

This is a Drupal recipe. To install a new site with it, the way Drupal CMS does it:

ddev drush site:install ../recipes/webapi_starter -y --account-name=webmaster

To apply it to a site you already have:

ddev composer require drupal/webapi_starter
ddev drush recipe ../recipes/contrib/webapi_starter
ddev drush cache:rebuild

Which starter

Start here when you want a Drupal site that is an API and not much else. For a site that also publishes a gallery of apps and the organizations behind them, use Webships Starter.

WebAPI Starter is not covered by Drupal's security advisory policy.

Supporting organizations: 
Initial building, ongoing maintenance and development

Project information

Releases