Drupal/C4/RESTful-API-with-a-REST-Client/English - Revision history

Priyacst at 11:18, 11 June 2018

2018-06-11T11:18:59Z

Nancyvarkey at 11:38, 8 June 2018

2018-06-08T11:38:16Z

Priyacst: Created page with " {| style="border-spacing:0;" | style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"|
2018-06-08T05:28:50Z

Created page with " {| style="border-spacing:0;" | style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| <cent..."

New page

{| style="border-spacing:0;"
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| <center>Visual cue</center>
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| <center>Narration</center>

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Slide 1:

RESTful API with a REST Client
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Welcome to the spoken tutorial on''' RESTful API with a REST Client'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Slide 2:Learning Objectives

* What is REST client
* Retrieve data - GET method
* Create a new node - POST method
* Modify an existing node - PATCH method
* Delete an existing node - DELETE method

| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| In this tutorial, we will learn about '''REST client. '''

We also learn to use the '''REST client '''to

* Retrieve data using '''GET method'''
* Create a new node using '''POST method'''
* Modify an existing node using '''PATCH method''' and
* Delete an existing node using '''DELETE method'''

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Slide 3:

System requirement

To record this tutorial, I am using

* Ubuntu Linux 16.04 OS
* Drupal 8
* Postman as a REST Client
* Firefox web browser

| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| To record this tutorial, I am using

* '''Ubuntu Linux 16.04'''
* '''Drupal 8 '''
* '''Postman '''as a''' REST client '''and
* '''Firefox web browser'''

You can use any '''REST client''' and web browser as per your choice.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Slide 4:

Pre-requisites

* You should have basic knowledge of '''Drupal'''
* '''RESTful API''' implemented in your Drupal website
* If not, for relevant''' Drupal''' tutorials please visit [http://spoken-tutorial.org/ http://spoken-tutorial.org]
* A working''' Internet connection'''

| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| To practise this tutorial, you should have basic knowledge of''' Drupal'''.

The '''RESTful API''' should have been implemented in your '''Drupal '''website.

If not, please go through the previous '''Drupal''' tutorials on this website.

You should also have a working '''Internet''' connection.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Open '''Drupa8''' site
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| First we will confirm whether RESTful API is implemented in our '''Drupal8''' site.

To do so, open our '''Drupa8''' site.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Go to '''Structure''' and '''Views'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Then go to '''Structure''' and '''Views'''.

Here you can see that '''RESTful API''' is implemented in the '''Events''' content type.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Show text '''Postman Client'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Note that we have already learnt to implement the '''RESTful API '''earlier.''' '''

Now we will learnt to check our '''RESTful API''' using a '''REST client'''.

I will use '''Postman '''as a''' REST client'''.

You can use any '''REST client''' as per your choice.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Slide 6: '''Postman Client'''

* It is a powerful HTTP client for testing web services
* For installing '''Postman client, '''see''' Additional reading material''' link

| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| '''Postman''' is a powerful '''HTTP client '''for testing '''web services.'''

To install the '''Postman client''', refer to the '''Additional reading material''' link of this tutorial.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Show text '''Bitnami Drupal Stack'''

| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| The following steps are applicable to '''Bitnami Drupal Stack'''.

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

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Open '''Postman Client'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Let us open the '''Postman client'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Choose '''GET'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| First we will learn to retrieve data for '''Anonymous users''' using '''GET''' method.

Choose '''GET''' from the drop-down list.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Type [http://localhost:8080/drupal/events http://localhost/drupal/events]

Highlight '''localhost:8080'''

Highlight '''drupal'''

Highlight events
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Recall that earlier we had implemented the '''RESTful API '''on our '''Events content type'''.

We will now enter the path of our '''RESTful API'''.

Here '''localhost:8080''' is my '''server '''name.

If you are not using '''Bitnami Drupal stack''', please use '''localhost '''instead of '''localhost:8080.'''

'''drupal''' is the folder of my '''Drupal '''instance.

'''events '''is the '''content type''' on which we have configured the '''RESTful API'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Send'''

Point to the result
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Now click on the '''Send''' button at the top right corner.

You can see here the contents of our '''events content type '''in''' json format'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click plus button

Type the path
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Next let us learn to retrieve a single '''node'''.

Click on the plus button at the top panel to add a new tab.

Choose '''GET''' from the dropdown list.

We have to give the exact path of the particular '''node'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Send'''

Point to the result

| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click on the '''Send''' button.

You can see here the content of that particular node is retrieved.

<nowiki><<PAUSE>></nowiki>

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click plus button

Choose '''POST'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Next let us learn to create a new '''node''' for '''Authenticated users''' using '''POST''' method.

Click on the plus button at the top panel to add a new tab.

Choose '''POST''' from the drop-down list.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Type '''http://localhost:8080/drupal/entity/node?_format=hal+json'''

Highlight '''localhost:8080'''

Highlight '''drupal'''

Highlight '''/node?_format=hal+json'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Type the path as shown.

Here '''localhost:8080''' is my '''server''' name.

'''drupal''' is the folder of my '''Drupal''' instance.

We have to hard-code the rest of the things.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Change '''Type''' as '''Basic Auth'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Under '''Authorization''', we will change the '''Type''' as '''Basic Authentication'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Type username and password
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Now we will give the '''username''' and '''password''' of our '''Drupal''' website.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Preview Request '''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click on the '''Preview Request''' button at the left hand side to update our '''request'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Headers''' tab

Point to '''Authentication'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click on the '''Headers''' tab.

Here you can see the '''token''' for the '''basic authentication'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Type''' Content-Type''' as '''application/hal+json'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| We will set the '''Content-Type''' to '''application/hal+json'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Body''' tab
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Now we will go to the '''Body''' tab.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Choose '''raw'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Let us change the '''data format''' as '''raw.'''

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| {

"_links": {

"type": {

"href": "http://localhost:8080:8080/drupal/rest/type/node/events"

}

},

<nowiki>"title":[</nowiki>

{

"value": "Created by an authenticated user!!!"

}

],

<nowiki>"body": [</nowiki>

{

"value": " This is an event!!!"

}

]

}
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Here we must declare the required '''title''' and '''type fields.'''

So type the following code.

This '''json''' code is used to create a new node of the type '''events'''.

For that we specify the values for title and body fields.

The same code is given in the '''Code files''' link of this tutorial.

Please download and use it.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Send'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click on the '''Send''' button at the top right corner.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Point to the '''json''' code
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| If the content is successfully posted, you can see the '''json '''code of this content at the bottom.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Switch to Drupal site

Point to the first event
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| We can also check the content in our '''Drupal''' website.

Switch back to our '''Drupal''' site.

Here you can see the '''event''' which is posted from the '''Postman client'''.

Note that the '''UID''' of this post is '''100'''.

We will use this '''UID''' in the postman client to modify this node.

<nowiki><<PAUSE>></nowiki>

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Switch to '''Postman Client'''

Click plus button
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Next let us learn to modify a node for '''Authenticated users''' using '''PATCH method.'''

Let us switch back to the '''Postman client.'''

Click on the plus button at the top panel to add a new tab.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Choose '''PATCH'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Choose '''PATCH''' from the drop-down list.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Type [http://localhost:8080/drupal/node/102 http://][http://localhost:8080/drupal/node/102 localhost:8080][http://localhost:8080/drupal/node/102 /drupal/node/10]0

Highlight 100
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| We will enter the '''URL''' of the '''node''' which we want to modify.

For example, we will modify the '''node''' which we created using '''POST method'''.

The '''UID''' of this '''node''' is '''100'''.

We will enter the URL of the node 100.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Change '''Type''' as '''Basic Auth'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Under '''Authorization''', we will change the '''Type''' as '''Basic Authentication'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Type username and password
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Now we will give the '''username''' and '''password '''of our '''Drupal''' website.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Preview Request '''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click on the '''Preview Request''' button at the left hand side.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Headers''' tab

Point to '''Authentication'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click on the '''Headers''' tab.

Here you can see the '''token''' for the '''basic authentication'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Type''' Content-Type''' as '''application/hal+json'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| We will set the '''Content-Type''' to '''application/hal+json'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Body''' tab
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Now we will go to the '''Body''' tab.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Choose '''raw'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Change the '''data format '''as '''raw.'''

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Type

{

"_links": {

"type": {

"href": "http://localhost:8080/drupal/rest/type/node/events"

}

},

<nowiki>"title":[</nowiki>

{

"value": "Changed by PATCH!!!"

}

],

<nowiki>"body": [</nowiki>

{

"value": " The value is changed by patch method!!!"

}

]

}
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| And type the following code here.

In this code we modify the values for both the title and the body fields.

The same code is given in the '''Code files''' link of this tutorial.

Please download and use it.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Send'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Then click on the '''Send''' button at the top right corner.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Point to '''Status OK'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| You can see the '''Status '''as '''200 OK''' which means the content is modified.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Switch to Drupal site

Refresh the page

Point to the first event
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Let us check the content in our '''Drupal '''website'''.'''

Switch back to our '''Drupal''' website.

Let us refresh the page.

Here you can see that the '''event''' is successfully modified using the '''PATCH method'''.

<nowiki><<PAUSE>></nowiki>

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Choose node 8

Point to node 8 in the URL
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Next let us learn to delete an existing '''node''' for '''Authenticated users''' using '''DELETE method.'''

I will choose node 100 which was created by me as an authenticated user.

Remember that we have permitted the '''authenticated users''' to delete their own content only.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Switch to '''Postman Client'''

Click plus button
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Switch back to the '''Postman client'''.

Click on the plus button to add a new tab.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Choose '''DELETE'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Choose '''DELETE''' from the drop-down list.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Type [http://localhost:8080/drupal/node/102 http://localhost:8080/drupal/node/]8'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| We will enter the '''URL''' of the '''node''' which we want to delete.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Change '''Type''' as '''Basic Auth'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Under '''Authorization''', we will change the '''Type''' as '''Basic Authentication'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Type username and password
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Now we will give the '''username''' and '''password''' of our '''Drupal''' website.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Preview Request '''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click on the '''Preview Request''' button at the left hand side.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Headers''' tab
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Then click on the '''Headers''' tab.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Type''' Content-Type''' as '''application/hal+json'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| We will set the '''Content-Type''' to '''application/hal+json'''.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click '''Send'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Click on the '''Send''' button at the top right corner.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Point to '''Status 204 No content'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| You can see the '''Status '''as''' 204 No content''' which means the content is deleted.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Switch to Drupal site
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Switch back to our '''Drupal''' site.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Refresh the page
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Let us refresh the page.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Point to '''Page not found'''
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| We can see that the '''node''' is successfully deleted.

<nowiki><<PAUSE>></nowiki>

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"|
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| This is all about the managing content through '''Postman client'''.

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

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Slide 7:

Summary

In this tutorial, we have learnt about-

* '''Postman client '''as a REST client
* Managing content through '''Postman client '''using '''GET, POST, PATCH '''and''' DELETE '''methods

| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Let us summarize.

In this tutorial, we have learnt about-

* '''Postman client '''as a REST client and
* Managing content through '''Postman client''' using '''GET, POST, PATCH '''and''' DELETE '''methods

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Slide 8:

Assignment

* Create some new '''articles''' through '''REST Client'''
* Modify the '''articles''' using '''PATCH method'''

| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| As an assignment

* Create some new '''articles''' through '''REST client '''and
* Modify the '''articles''' using '''PATCH method'''

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Slide 9:

Acknowledgement

| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| The video at the following link summarises the Spoken Tutorial project.

Please download and watch it.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Slide 10:

Spoken Tutorial Workshops

| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| The Spoken Tutorial Project Team conducts workshops and gives certificates to those who pass online tests.

For more details, please write to us.

|-
| style="background-color:#ffffff;border:0.75pt solid #000001;padding-top:0.106cm;padding-bottom:0.106cm;padding-left:0.078cm;padding-right:0.106cm;"| Slide 11:

Acknowledgement

| style="background-color:#ffffff;border:0.75pt solid #000001;padding-top:0.106cm;padding-bottom:0.106cm;padding-left:0.078cm;padding-right:0.106cm;"| Spoken Tutorial Project is funded by

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

Government of India.

|-
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"|
| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| This tutorial is contributed by Vishal Jindal.

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

|}

← Older revision		Revision as of 11:18, 11 June 2018
Line 379:		Line 379:


−	The '''UID''' of this '''~~node~~''' is '''100'''.	+	The '''UID''' of this '''post''' is '''100'''.

@@ Line 15: / Line 15: @@
 * What is REST client
 * Retrieve data - GET method
-* Create a new node - POST method
+* Create a new '''node''' - POST method
-* Modify an existing node - PATCH method
+* Modify an existing '''node''' - PATCH method
-* Delete an existing node - DELETE method
+* Delete an existing '''node''' - DELETE method
-−
 | style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| In this tutorial, we will learn about '''REST client. '''
@@ Line 29: / Line 28: @@
 * Modify an existing node using '''PATCH method''' and
 * Delete an existing node using '''DELETE method'''
 |-
@@ Line 43: / Line 40: @@
 * Postman as a REST Client
 * Firefox web browser
 | style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| To record this tutorial, I am using
@@ Line 78: / Line 73: @@
 |-
 | style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Open '''Drupa8''' site
-| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| First we will confirm whether RESTful API is implemented in our '''Drupal8''' site.
+| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| First we will confirm whether '''RESTful API''' is implemented in our '''Drupal8''' site.
@@ Line 88: / Line 83: @@
-Here you can see that '''RESTful API''' is implemented in the '''Events''' content type.
+Here you can see that '''RESTful API''' is implemented in the '''Events content type'''.
 |-
 | style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Show text '''Postman Client'''
-| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Note that we have already learnt to implement the '''RESTful API '''earlier.''' '''
+| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Note that we have already learnt to implement the '''RESTful API '''earlier.
@@ Line 106: / Line 101: @@
 | style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Slide 6: '''Postman Client'''
-* It is a powerful HTTP client for testing web services
+* It is a powerful '''HTTP client''' for testing '''web services'''
 * For installing '''Postman client, '''see''' Additional reading material''' link
@@ Line 122: / Line 117: @@
-But most of the steps are applicable to any other '''Drupal''' installation, as well.
+But most of the steps are applicable to any other '''Drupal installation''', as well.
 |-
@@ Line 130: / Line 125: @@
 |-
 | style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Choose '''GET'''
-| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| First we will learn to retrieve data for '''Anonymous users''' using '''GET''' method.
+| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| First we will learn to retrieve data for '''Anonymous users''' using '''GET method'''.
@@ Line 200: / Line 195: @@
-You can see here the content of that particular node is retrieved.
+You can see here the content of that particular '''node''' is retrieved.
@@ Line 210: / Line 205: @@
 Choose '''POST'''
-| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Next let us learn to create a new '''node''' for '''Authenticated users''' using '''POST''' method.
+| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Next let us learn to create a new '''node''' for '''Authenticated users''' using '''POST method'''.
@@ Line 351: / Line 346: @@
-We will use this '''UID''' in the postman client to modify this node.
+We will use this '''UID''' in the postman client to modify this '''node'''.
@@ Line 361: / Line 356: @@
 Click plus button
-| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Next let us learn to modify a node for '''Authenticated users''' using '''PATCH method.'''
+| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Next let us learn to modify a '''node''' for '''Authenticated users''' using '''PATCH method.'''
@@ Line 387: / Line 382: @@
-We will enter the URL of the node 100.
+We will enter the URL of the '''node 100'''.
 |-
@@ Line 465: / Line 460: @@
-In this code we modify the values for both the title and the body fields.
+In this code we modify the values for both the '''title''' and the '''body fields'''.
@@ Line 489: / Line 484: @@
 Point to the first event
-| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Let us check the content in our '''Drupal '''website'''.'''
+| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Let us check the content in our '''Drupal '''website.
@@ Line 511: / Line 506: @@
-I will choose node 100 which was created by me as an authenticated user.
+I will choose '''node 100''' which was created by me as an '''authenticated user'''.
@@ Line 579: / Line 574: @@
 |-
 | style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"|
-| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| This is all about the managing content through '''Postman client'''.
+| style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| This is all about managing content through '''Postman client'''.
@@ Line 593: / Line 588: @@
 * '''Postman client '''as a REST client
 * Managing content through '''Postman client '''using '''GET, POST, PATCH '''and''' DELETE '''methods
 | style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| Let us summarize.
@@ Line 600: / Line 594: @@
 In this tutorial, we have learnt about-
-* '''Postman client '''as a REST client and
+* '''Postman client '''as a '''REST client''' and
-* Managing content through '''Postman client''' using '''GET, POST, PATCH '''and''' DELETE '''methods
+* Managing content through '''Postman client''' using '''GET, POST, PATCH '''and''' DELETE methods'''
-−
-−
 |-
@@ Line 612: / Line 604: @@
 * Create some new '''articles''' through '''REST Client'''
 * Modify the '''articles''' using '''PATCH method'''
 | style="background-color:#ffffff;border:1pt solid #000001;padding-top:0cm;padding-bottom:0cm;padding-left:0.062cm;padding-right:0.191cm;"| As an assignment
 * Create some new '''articles''' through '''REST client '''and
 * Modify the '''articles''' using '''PATCH method'''
 |-