{"id":17763,"date":"2020-08-29T13:12:35","date_gmt":"2020-08-29T13:12:35","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=17763"},"modified":"2021-10-29T09:58:39","modified_gmt":"2021-10-29T09:58:39","slug":"how-to-create-rest-api-in-laravel","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/how-to-create-rest-api-in-laravel\/","title":{"rendered":"How to Create REST API in Laravel."},"content":{"rendered":"\n<p><strong><span class=\"has-inline-color has-vivid-red-color\">API <\/span><\/strong>is also known as&nbsp;<strong>Web services<\/strong>. <strong><span class=\"has-inline-color has-vivid-red-color\">Web services<\/span><\/strong> is very <strong>important <\/strong>when you are creating <strong>web <\/strong>and&nbsp;<strong>Mobile app<\/strong>. You require API in mobile application development. If you Don&#8217;t know how to create <strong>REST API<\/strong> in laravel then just follow the below Steps, i&#8217;m explaining everything step-by-step. &nbsp;<\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong><span class=\"has-inline-color has-vivid-red-color\">Step 1:<\/span> Install Laravel<\/strong><\/h3>\n\n\n\n<p>In the first step, we require to get fresh <strong>Laravel <\/strong>application using below command, So open your <strong>terminal<\/strong> OR command prompt and run below command:<\/p>\n\n\n<pre class=\"wp-block-code\" aria-describedby=\"shcb-language-1\" data-shcb-language-name=\"JavaScript\" data-shcb-language-slug=\"javascript\"><span><code class=\"hljs language-javascript\">composer create-project --prefer-dist laravel\/laravel laravel_api <span class=\"hljs-string\">\"5.4.*\"<\/span><\/code><\/span><small class=\"shcb-language\" id=\"shcb-language-1\"><span class=\"shcb-language__label\">Code language:<\/span> <span class=\"shcb-language__name\">JavaScript<\/span> <span class=\"shcb-language__paren\">(<\/span><span class=\"shcb-language__slug\">javascript<\/span><span class=\"shcb-language__paren\">)<\/span><\/small><\/pre>\n\n\n<h3 class=\"wp-block-heading\"><strong><span class=\"has-inline-color has-vivid-red-color\">Step 2:<\/span>  Make Database Configuration<\/strong><\/h3>\n\n\n\n<div class=\"wp-block-image\"><figure class=\"aligncenter size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/database-configuration.png\" alt=\"\" class=\"wp-image-17767\" width=\"230\" height=\"124\"\/><\/figure><\/div>\n\n\n\n<h3 class=\"wp-block-heading\"><strong><span class=\"has-inline-color has-vivid-red-color\">Step 3:<\/span>  Make <\/strong>Authentication scaffold<\/h3>\n\n\n\n<p>Make Laravel Authentication scaffold by below command and migrate<\/p>\n\n\n<pre class=\"wp-block-code\" aria-describedby=\"shcb-language-2\" data-shcb-language-name=\"CSS\" data-shcb-language-slug=\"css\"><span><code class=\"hljs language-css\">1. <span class=\"hljs-selector-tag\">php<\/span> <span class=\"hljs-selector-tag\">artisan<\/span> <span class=\"hljs-selector-tag\">make<\/span><span class=\"hljs-selector-pseudo\">:auth<\/span>\n\n2. <span class=\"hljs-selector-tag\">php<\/span> <span class=\"hljs-selector-tag\">artisan<\/span> <span class=\"hljs-selector-tag\">make<\/span><span class=\"hljs-selector-pseudo\">:auth<\/span><\/code><\/span><small class=\"shcb-language\" id=\"shcb-language-2\"><span class=\"shcb-language__label\">Code language:<\/span> <span class=\"shcb-language__name\">CSS<\/span> <span class=\"shcb-language__paren\">(<\/span><span class=\"shcb-language__slug\">css<\/span><span class=\"shcb-language__paren\">)<\/span><\/small><\/pre>\n\n\n<h3 class=\"wp-block-heading\"><strong><span class=\"has-inline-color has-vivid-red-color\">Step 4:<\/span> <\/strong> Add Dummy Data in Table.<\/h3>\n\n\n\n<p>Add some dummy data in users table so that when we call our API then it return the dummy data.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong><span class=\"has-inline-color has-vivid-red-color\">Step 5:<\/span><\/strong> <strong>Create the Controller<\/strong>.<\/h3>\n\n\n\n<p>Now, lets make a Controller in which we call country table to call the data from table. first, create a directory named API and under api create a Controller and put the below code.<\/p>\n\n\n<pre class=\"wp-block-code\" aria-describedby=\"shcb-language-3\" data-shcb-language-name=\"HTML, XML\" data-shcb-language-slug=\"xml\"><span><code class=\"hljs language-xml\"><span class=\"php\"><span class=\"hljs-meta\">&lt;?php<\/span>\n\n<span class=\"hljs-keyword\">namespace<\/span> <span class=\"hljs-title\">App<\/span>\\<span class=\"hljs-title\">Http<\/span>\\<span class=\"hljs-title\">Controllers<\/span>\\<span class=\"hljs-title\">api<\/span>;\n\n<span class=\"hljs-keyword\">use<\/span> <span class=\"hljs-title\">Illuminate<\/span>\\<span class=\"hljs-title\">Http<\/span>\\<span class=\"hljs-title\">Request<\/span>;\n<span class=\"hljs-keyword\">use<\/span> <span class=\"hljs-title\">App<\/span>\\<span class=\"hljs-title\">Http<\/span>\\<span class=\"hljs-title\">Controllers<\/span>\\<span class=\"hljs-title\">Controller<\/span>;\n<span class=\"hljs-keyword\">use<\/span> <span class=\"hljs-title\">DB<\/span>;\n<span class=\"hljs-keyword\">use<\/span> <span class=\"hljs-title\">App<\/span>\\<span class=\"hljs-title\">User<\/span>;\n\n<span class=\"hljs-class\"><span class=\"hljs-keyword\">class<\/span> <span class=\"hljs-title\">apicontroller<\/span> <span class=\"hljs-keyword\">extends<\/span> <span class=\"hljs-title\">Controller<\/span>\n<\/span>{\n   \n   <span class=\"hljs-keyword\">public<\/span> <span class=\"hljs-function\"><span class=\"hljs-keyword\">function<\/span> <span class=\"hljs-title\">index<\/span><span class=\"hljs-params\">()<\/span>\n    <\/span>{\n        <span class=\"hljs-keyword\">return<\/span> User::all();\n    }\n}\n<\/span><\/code><\/span><small class=\"shcb-language\" id=\"shcb-language-3\"><span class=\"shcb-language__label\">Code language:<\/span> <span class=\"shcb-language__name\">HTML, XML<\/span> <span class=\"shcb-language__paren\">(<\/span><span class=\"shcb-language__slug\">xml<\/span><span class=\"shcb-language__paren\">)<\/span><\/small><\/pre>\n\n\n<p>See the below image of Controller.<\/p>\n\n\n\n<div class=\"wp-block-image\"><figure class=\"aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"486\" height=\"409\" src=\"https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/apicontroller.png\" alt=\"\" class=\"wp-image-17773\" srcset=\"https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/apicontroller.png 486w, https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/apicontroller-300x252.png 300w\" sizes=\"auto, (max-width: 486px) 100vw, 486px\" \/><\/figure><\/div>\n\n\n\n<h3 class=\"wp-block-heading\"><strong><span class=\"has-inline-color has-vivid-red-color\">Step 6:<\/span><\/strong> <strong>Create API Route<\/strong>.<\/h3>\n\n\n\n<p>Make api route to call our API. Go to routes\/api.php and put the below code.<\/p>\n\n\n<pre class=\"wp-block-code\" aria-describedby=\"shcb-language-4\" data-shcb-language-name=\"PHP\" data-shcb-language-slug=\"php\"><span><code class=\"hljs language-php\">Route::get(<span class=\"hljs-string\">'countries'<\/span>, <span class=\"hljs-string\">'api\\apicontroller@index'<\/span>);<\/code><\/span><small class=\"shcb-language\" id=\"shcb-language-4\"><span class=\"shcb-language__label\">Code language:<\/span> <span class=\"shcb-language__name\">PHP<\/span> <span class=\"shcb-language__paren\">(<\/span><span class=\"shcb-language__slug\">php<\/span><span class=\"shcb-language__paren\">)<\/span><\/small><\/pre>\n\n\n<p>See the below Image <\/p>\n\n\n\n<div class=\"wp-block-image\"><figure class=\"aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"975\" height=\"407\" src=\"https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/api-routes.png\" alt=\"\" class=\"wp-image-17777\" srcset=\"https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/api-routes.png 975w, https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/api-routes-300x125.png 300w, https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/api-routes-768x321.png 768w\" sizes=\"auto, (max-width: 975px) 100vw, 975px\" \/><\/figure><\/div>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Step 7:<\/strong> Call<strong> API Route<\/strong>.<\/h3>\n\n\n\n<p>Now we call the API route to access our Data. API URl is like <\/p>\n\n\n\n<p><strong>www.domainname.com\/api\/your_api_route.<\/strong><\/p>\n\n\n\n<p>I&#8217;m running my project in local so my url is <strong>http:\/\/localhost\/laravel_api\/public\/api\/countries<\/strong><\/p>\n\n\n\n<p>Open the API url to access the data. See the Below Image <\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"139\" src=\"https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/How-to-Create-REST-API-in-Laravel-1024x139.png\" alt=\"\" class=\"wp-image-17779\" srcset=\"https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/How-to-Create-REST-API-in-Laravel-1024x139.png 1024w, https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/How-to-Create-REST-API-in-Laravel-300x41.png 300w, https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/How-to-Create-REST-API-in-Laravel-768x104.png 768w, https:\/\/www.devopsschool.com\/blog\/wp-content\/uploads\/2020\/08\/How-to-Create-REST-API-in-Laravel.png 1360w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n<div class=\"epyt-gallery\" data-currpage=\"1\" id=\"epyt_gallery_79212\"><figure class=\"wp-block-embed wp-block-embed-youtube is-type-video is-provider-youtube epyt-figure\"><div class=\"wp-block-embed__wrapper\"><iframe loading=\"lazy\"  id=\"_ytid_18696\"  width=\"760\" height=\"427\"  data-origwidth=\"760\" data-origheight=\"427\" src=\"https:\/\/www.youtube.com\/embed\/?enablejsapi=1&#038;autoplay=0&#038;cc_load_policy=0&#038;cc_lang_pref=&#038;iv_load_policy=1&#038;loop=0&#038;rel=1&#038;fs=1&#038;playsinline=0&#038;autohide=2&#038;theme=dark&#038;color=red&#038;controls=1&#038;disablekb=0&#038;\" class=\"__youtube_prefs__  no-lazyload\" title=\"YouTube player\"  data-epytgalleryid=\"epyt_gallery_79212\"  allow=\"fullscreen; accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" referrerpolicy=\"strict-origin-when-cross-origin\" allowfullscreen data-no-lazy=\"1\" data-skipgform_ajax_framebjll=\"\"><\/iframe><\/div><\/figure><div class=\"epyt-gallery-list\"><div>Sorry, there was a YouTube error.<\/div><\/div><\/div>","protected":false},"excerpt":{"rendered":"<p>API is also known as&nbsp;Web services. Web services is very important when you are creating web and&nbsp;Mobile app. You require API in mobile application development. If you Don&#8217;t know how to create REST API in laravel then just follow the below Steps, i&#8217;m explaining everything step-by-step. &nbsp; Step 1: Install Laravel In the first step,&#8230;<\/p>\n","protected":false},"author":19,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"_kad_post_classname":"","_joinchat":[],"footnotes":""},"categories":[5201],"tags":[5203,5456],"class_list":["post-17763","post","type-post","status-publish","format-standard","hentry","category-laravel","tag-laravel","tag-rest-api"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/17763","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/19"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=17763"}],"version-history":[{"count":2,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/17763\/revisions"}],"predecessor-version":[{"id":24585,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/17763\/revisions\/24585"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=17763"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=17763"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=17763"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}