Difference between revisions of "Drupal/C4/RESTful-API-Implementation/English"

RESTful API Implementation

• Understand what is RESTful API
• Learn to implement RESTful API using Views

• Understand what is RESTful API
• Learn to implement RESTful API using Views

System requirement

To record this tutorial, I am using

• Ubuntu Linux 16.04 OS
• Drupal 8
• Firefox web browser

• Ubuntu Linux 16.04
• Drupal 8 and
• Firefox web browser

You can use any web browser as per your choice.

Pre-requisites

• You should have basic knowledge of Drupal
• If not, for relevant Drupal tutorials please visit http://spoken-tutorial.org
• A working Internet connection

If not, for relevant Drupal tutorials, please visit the link shown.

You should also have a working Internet connection.

What is RESTful API

• It is based on REpresentational State Transfer (REST) technology
• It is also referred to as a RESTful web service

• RESTful API is based on REpresentational State Transfer (i.e REST) technology.
• It is also referred to as a RESTful web service.
• RESTful API provides methods to external clients to fetch, add or modify data on the server.

• Using the same server, we can do a bank transaction either using a mobile app or desktop website.

So any application, such as

• another website,
• native mobile apps and
• IoT devices

can exchange data with your server.

Show text Bitnami Drupal Stack

The following steps are applicable to Bitnami Drupal Stack.

But most of the steps are applicable to any other Drupal installation, as well.

Open Drupal8 site

First we will open our Drupal8 site and install the required core modules.

and Serialization

HAL, HTTP Basic Authentication, RESTful Web Services and Serialization.

Show text Creating Dummy Content

I have already installed and enabled it in my machine.

To know how to install a module, go through the Creating Dummy Content tutorial in this series.

Go to Configuration tab -> WEB SERVICES → REST

Next we will configure the REST resources to accept the requests from a REST client.

To do so, go to the Configuration tab.

Click on REST under WEB SERVICES.

Click on Edit of Content

We will restrict the formats by clicking on the Edit button of Content.

Check json

Under Accepted request formats, put a check mark on the json.

Now our Drupal site will accept the json format requests from a REST client.

Next we need to set the proper permissions for authenticated users.

1. anonymous user

2. authenticated user and

3. authenticated users with permission to modify content

Now, we will setup our Drupal for an authenticated user who can create, edit, and delete their own contents.

For AUTHENTICATED USER, check

• Basic Page: Create new content
• Basic Page: Delete own content
• Basic Page: Edit own content

• Basic Page: Create new content
• Basic Page: Delete own content
• Basic Page: Edit own content

Click on the Save permissions button at the bottom.

You can give permissions based on your requirements.

Go to Structure -> Content types

Point to Events

Now we need a content type on which we want to implement the RESTful API.

Go to Structure tab and click on the Content types.

I will use the Events content type to implement the RESTful API.

You can use any content type as per your requirement.

Show text Displaying Contents using Views

Now we need a View for our Events content type.

To know about Views, go through the tutorial Displaying Contents using Views of this series.

Type Events_view

Under FORMAT section, in the Show option, click on the Entity.

Click Apply

Click on the Apply button.

Then click on the Apply button.

This will enable us to add fields to our view.

Click on the Add button.

This brings up the list of available fields.

Click Apply

Then click on the Apply button.

Click Save

We will click on the Save button to save this view.

<<PAUSE>>

Click Add

Next we will create a new view to retrieve the data.

Click on the Add button in the Displays panel.

Now let us configure this new view.

Click Apply

And click on the Apply button.

Highlight the hint under the field.

Percentage sign is used to represent values that will be used for the contextual filter.

Choose ID

Search for id and choose the ID from the list.

Then click on the Apply button.

With this, we have successfully implemented the RESTful API in our Drupal site using Views.

<<PAUSE>>

With this, we come to the end of this tutorial.

Summary

• RESTful API
• Implementation of RESTful API using Views

In this tutorial, we have learnt about-

• RESTful API and
• Implementation of RESTful API using Views

Assignment

• Implement the RESTful API on the Article content type

• Implement the RESTful API on the Article content type

Acknowledgement

Please download and watch it.

Spoken Tutorial Workshops

For more details, please write to us.

Acknowledgement

• NMEICT, Ministry of Human Resource Development and
• NVLI, Ministry of Culture

Government of India.

This is Priya from IIT Bombay signing off. Thanks for joining.