Gosod Cymhwysiad Rails Dim API

Mae creu cymhwysiad Rails dim API yn broses syml sy'n cynnig llawer o fuddion i ddatblygwyr sy'n dymuno adeiladu gwasanaethau gwe sy'n seiliedig ar API. Yn yr erthygl hon, byddwn yn archwilio'r camau sydd eu hangen i sefydlu cymhwysiad Rails dim API, gan gynnwys gosod y feddalwedd angenrheidiol, creu modelau, a darparu llwyfan ar gyfer ymholiadau. Gadewch i ni ddechrau!

Cam 1: Gosod y Feddalwedd Angenrheidiol

Y cam cyntaf wrth sefydlu cymhwysiad Rails dim API yw sicrhau bod gennych y feddalwedd angenrheidiol ar eich peiriant. Mae angen i chi gael Ruby, Rails, a'r rheiny sy'n gysylltiedig â'r feddalwedd. Dyma'r camau i'w dilyn:

# 1. Gosod Ruby
sudo apt-get install ruby-full

# 2. Gosod Rails
gem install rails

# 3. Gosod PostgreSQL (neu unrhyw ddata a dymunwch)
sudo apt-get install postgresql postgresql-contrib libpq-dev

Ar ôl i chi gwblhau'r gosodiadau hyn, gallwch ddechrau creu eich cymhwysiad Rails dim API.

Cam 2: Creu Cymhwysiad Rails Dim API

Unwaith y bydd y feddalwedd wedi'i gosod, gallwch greu cymhwysiad Rails dim API. Mae Rails yn cynnig opsiwn i greu cymhwysiadau sy'n seiliedig ar API yn syth. Defnyddiwch y gorchymyn canlynol:

rails new my_api_app --api

Mae'r flag --api yn sicrhau bod y cymhwysiad yn cael ei greu fel cymhwysiad dim API, gan leihau'r nifer o ffeiliau a'r cyfarwyddiadau sydd eu hangen arnoch.

Cam 3: Defnyddio Modelau a Chreu Cronfeydd Data

Ar ôl creu'r cymhwysiad, mae angen i chi greu modelau a chreu cronfeydd data. Mae Rails yn cynnig dulliau hawdd i greu modelau a rheoli cronfeydd data. Dyma sut i wneud hynny:

Creu Model

Gallwch greu model newydd gan ddefnyddio'r gorchymyn canlynol:

rails generate model Product name:string price:decimal

Mae'r gorchymyn hwn yn creu model o'r enw Product gyda dau faes: name a price.

Creu Cronfa Ddata

Ar ôl creu'r model, gallwch greu cronfa ddata trwy ddefnyddio'r gorchymyn canlynol:

rails db:migrate

Mae hyn yn cymryd y newidiadau a wnaed yn y model a'u rhoi i'r gronfa ddata.

Cam 4: Creu Rheolwyr (Controllers)

Mae rheolwyr yn hanfodol ar gyfer rheoli ymholiadau i'r API. Mae angen i chi greu rheolwr ar gyfer eich model. Dyma sut i greu rheolwr ar gyfer y model Product:

rails generate controller Products

Mae hyn yn creu rheolwr o'r enw ProductsController. Gallwch ychwanegu gweithredoedd i'r rheolwr hwn i reoli ymholiadau.

Ychwanegu Gweithredoedd i'r Rheolwr

Gallwch ychwanegu gweithredoedd i'r rheolwr fel a ganlyn:

class ProductsController < ApplicationController
  def index
    @products = Product.all
    render json: @products
  end

  def show
    @product = Product.find(params[:id])
    render json: @product
  end

  def create
    @product = Product.new(product_params)
    if @product.save
      render json: @product, status: :created
    else
      render json: @product.errors, status: :unprocessable_entity
    end
  end

  private

  def product_params
    params.require(:product).permit(:name, :price)
  end
end

Mae'r gweithredoedd hyn yn caniatáu i chi gael rhestr o gynhyrchion, dangos cynnyrch penodol, a chreu cynnyrch newydd.

Cam 5: Defnyddio Rhyngwyneb API

Ar ôl creu'r rheolwr, gallwch ddefnyddio rhyngwyneb API i wneud ymholiadau. Mae angen i chi ychwanegu llwybrau i'ch cymhwysiad. Gallwch wneud hyn yn y ffeil config/routes.rb:

Rails.application.routes.draw do
  resources :products
end

Mae hyn yn creu llwybrau ar gyfer y gweithredoedd a grëwyd yn y rheolwr.

Cam 6: Profi'r API

Mae'n bwysig profi'r API i sicrhau ei fod yn gweithio'n iawn. Gallwch ddefnyddio cyrchwr fel Postman neu curl i wneud ymholiadau i'r API. Dyma enghraifft o sut i ddefnyddio curl i wneud cais i'r API:

# Cais i gael rhestr o gynhyrchion
curl -X GET http://localhost:3000/products

# Cais i greu cynnyrch newydd
curl -X POST http://localhost:3000/products -d "product[name]=Cynnyrch Newydd&product[price]=19.99"

Mae'r ymholiadau hyn yn dangos sut i gael a chreu cynhyrchion trwy'r API.

Cam 7: Diogelu'r API

Mae diogelwch yn bwysig iawn pan fyddwch yn gweithio gyda chymwysiadau API. Mae angen i chi ystyried defnyddio awdurdodiad a dilysu i sicrhau bod dim ond defnyddwyr a dderbynnir yn gallu cael mynediad i'r API. Gallwch ddefnyddio gemau fel Devise neu JWT i gyflawni hyn.

Casgliad

Mae sefydlu cymhwysiad Rails dim API yn broses syml sy'n cynnig llawer o fuddion i ddatblygwyr. Trwy ddilyn y camau a ddisgrifiwyd yn yr erthygl hon, gallwch greu API sy'n galluogi defnyddwyr i wneud ymholiadau a chynnal gweithrediadau ar ddata. Peidiwch ag anghofio ystyried diogelwch a phrofi'r API i sicrhau ei fod yn gweithio'n iawn. Mae'n amser i chi ddechrau adeiladu eich cymhwysiad Rails dim API!