{"id":6517,"date":"2015-07-16T00:12:31","date_gmt":"2015-07-16T00:12:31","guid":{"rendered":"https:\/\/dev.railscarma.com\/what-is-rest-api\/"},"modified":"2020-10-16T20:46:57","modified_gmt":"2020-10-16T20:46:57","slug":"what-is-rest-api","status":"publish","type":"post","link":"https:\/\/www.railscarma.com\/sv\/blogg\/tekniska-artiklar\/what-is-rest-api\/","title":{"rendered":"Vad \u00e4r REST API?"},"content":{"rendered":"

API, an abbreviation of application program interface, is a set of practices, protocols, and tools for building software applications. Sometimes we me may need third party integration for our web application. To achieve it REST API is an easy thing. Advantage of Rest API will be language independent.<\/p>\n

REST (REpresentational State Transfer) is a simple architecture that runs over HTTPS or TLS. The REST style emphasizes that interactions between clients and services are enhanced by having a limited number of operations.<\/p>\n

Flexibility is provided by allocating resources their own sole universal resource indicators (URIs). Because each operation (GET, POST, PUT, and DELETE) has a specific meaning, REST avoids uncertainty.<\/p>\n

Building a simple REST API:<\/h3>\n

API do not need any view as user do not interact with the application directly. We just specify the data that third party will send.<\/p>\n

There will be no view or edit action as we don\u2019t have any view here.\u00a0For Every request will return some data with status code and success failure message. The data may in the form of json or xml.<\/p>\n

Requirement :\u00a0gem ‘rails-api’<\/p>\n

While creating application create as rails-api new [application_name], so that it avoids view, assets\/stylesheets and assets\/javascript.<\/p>\n

We have to namespace our API which keeps our code clean and keeps your APIs independent from the rest of your controllers.\u00a0We start this by adding in our routes.<\/p>\n

routes.rb<\/p>\n

namespace :api do
\nresources :users
\nslutet<\/p><\/blockquote>\n

It will look for a UsersController in\u00a0app\/controllers\/api\/users_controller.rb<\/p>\n

class api::UsersController < ApplicationController<\/p>\n

slutet<\/p>\n

I hope you all are familiar with simple CRUD operations, do the same here but it wont have any view so instead redirection we need to render some data with status code.<\/p>\n

For Ex.<\/strong><\/p>\n

class Api::UsersController < ApplicationController<\/p>\n

def index
\n@users = User.all
\nrespond_to do |format|
\nformat.json { render json: @users }
\nformat.xml { render xml: @users }
\nslutet
\nslutet<\/p>\n

def f\u00f6rst\u00f6ra
\nrespond_to do |format|
\nif @user.destroy
\nformat.json { head :no_content, status: :Deleted Successfully }
\nformat.xml { head :no_content, status: :Deleted Successfully }
\nannan
\nformat.json { render json: @user.errors, status: :Unable }
\nformat.xml { render xml: @user.errors, status: :Unable }
\nslutet
\nslutet
\nslutet<\/p>\n

slutet<\/p><\/blockquote>\n

In this way we can build a \u00a0REST API.<\/p>\n

If you need to add any new feature, any changes in your API you can make a versions of your API.<\/p>\n

Versioning of API<\/strong><\/p>\n

In routes.rb<\/p>\n

namespace :api do<\/p>\n

namespace :v1 do<\/p>\n

resources :users
\nslutet
\nslutet<\/p><\/blockquote>\n

It will look for a UsersController in
\napp\/controllers\/api\/v1\/users_controller.rb<\/p>\n

class Api::V1::UsersController < ApplicationController<\/p>\n

slutet<\/p>\n

Finally provide the API Documentation for the users<\/p>\n

API Requests:<\/p>\n

Listing users<\/p>\n

url: http:\/\/localhost:3000\/api\/users
\nmethod: GET<\/p><\/blockquote>\n

Deleting User<\/p>\n

url: http:\/\/localhost:3000\/api\/users\/:id
\nmethod: DELETE<\/p><\/blockquote>\n

RailsCarma, a branded and reputed Global Rails Company in providing high end RoR development services over a decade. It provides updated and high-level solutions for all RoR services.<\/p>\n

L\u00e4s liknande artiklar:<\/p>\n