{"id":37978,"date":"2024-07-11T05:22:36","date_gmt":"2024-07-11T05:22:36","guid":{"rendered":"https:\/\/www.railscarma.com\/?p=37978"},"modified":"2024-07-11T05:22:40","modified_gmt":"2024-07-11T05:22:40","slug":"building-a-restful-api-using-grape-in-ruby-on-rails","status":"publish","type":"post","link":"https:\/\/www.railscarma.com\/sv\/blogg\/building-a-restful-api-using-grape-in-ruby-on-rails\/","title":{"rendered":"Bygga ett RESTful API med Grape i Ruby on Rails"},"content":{"rendered":"
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

N\u00e4r det g\u00e4ller webbutveckling \u00e4r det vanligt att skapa RESTful API:er. RESTful API:er g\u00f6r det m\u00f6jligt f\u00f6r olika system att kommunicera \u00f6ver HTTP p\u00e5 ett standardiserat s\u00e4tt, vilket g\u00f6r dem till en integrerad del av moderna webbapplikationer. Ruby on Rails (RoR) tillhandah\u00e5ller ett robust ramverk f\u00f6r webbutveckling, och med till\u00e4gget av Grape, ett mikroramverk f\u00f6r att skapa API:er, blir det \u00e4nnu mer str\u00f6mlinjeformat och effektivt att bygga ett RESTful API. Den h\u00e4r artikeln guidar dig genom processen att bygga ett RESTful API med hj\u00e4lp av Grape i en Ruby on Rails-applikation, komplett med ett exempel.<\/span><\/p>\n

Vad \u00e4r druva?<\/b><\/h2>\n

Grape \u00e4r ett Ruby-ramverk som \u00e4r s\u00e4rskilt utformat f\u00f6r att skapa REST-liknande API:er. Det \u00e4r l\u00e4ttviktigt och kompletterar Rails v\u00e4l och erbjuder en enkel DSL (Domain-Specific Language) f\u00f6r att definiera RESTful API:er. Grape g\u00f6r att du kan fokusera p\u00e5 API-logiken samtidigt som du hanterar vanliga uppgifter som parametervalidering, formatering och versionshantering.<\/span><\/p>\n

Konfigurera Grape i en Rails-applikation<\/b><\/h2>\n

F\u00f6r att komma ig\u00e5ng beh\u00f6ver du en Rails-applikation. Om du inte redan har en kan du skapa en ny Rails-applikation med:<\/span><\/p>\n

rails ny grape_api_example
<\/span>cd grape_api_example<\/span><\/pre>\n
L\u00e4gg till p\u00e4rlan Grape i din <\/span>Gemfil<\/b><\/span>:<\/b>
<\/span><\/p>\n
<\/p>\n
p\u00e4rla \"druva<\/span><\/pre>\n
<\/p>\n
Springa <\/span>paketinstallation<\/b> f\u00f6r att installera gemen.<\/span><\/p>\n
Skapa API:et<\/b><\/h2>\n
Skapa en ny katalog f\u00f6r ditt API under <\/span>app<\/b>:<\/span><\/p>\n
mkdir app\/api<\/span><\/pre>\n
<\/p>\n
Skapa sedan en basklass f\u00f6r ditt API. Denna klass kommer att \u00e4rva fr\u00e5n <\/span>Grape::API<\/b> och fungerar som grunden f\u00f6r dina slutpunkter. Skapa en fil <\/span>app\/api\/base_api.rb<\/b> och l\u00e4gg till f\u00f6ljande kod:<\/span><\/p>\n
modul API
<\/span>  klass Bas < Grape::API
<\/span>    format :json
<\/span>    rescue_from :all do |e|
<\/span>      error_response(meddelande: e.meddelande, status: 500)
<\/span>    slutet
<\/span>    montera API::V1::Base
<\/span>  slutet
<\/span>slutet<\/span><\/pre>\n
<\/p>\n
Versionering av ditt API<\/b><\/h2>\n
Versionering \u00e4r avg\u00f6rande f\u00f6r att uppr\u00e4tth\u00e5lla bak\u00e5tkompatibilitet. I det h\u00e4r exemplet kommer vi att skapa version 1 av v\u00e5rt API. Skapa en katalog <\/span>app\/api\/v1<\/b> och en basfil <\/span>app\/api\/v1\/base.rb<\/b>:<\/span><\/p>\n
modul API
<\/span>  modul V1
<\/span>    klass Bas < Grape::API
<\/span>      version 'v1', anv\u00e4ndning: :s\u00f6kv\u00e4g
<\/span>      montera API::V1::Anv\u00e4ndare
<\/span>    slutet
<\/span>  slutet
<\/span>slutet<\/span><\/pre>\n
<\/p>\n
Definiera slutpunkter<\/b><\/h3>\n
L\u00e5t oss skapa en enkel endpoint f\u00f6r att hantera anv\u00e4ndare. Skapa en fil <\/span>app\/api\/v1\/anv\u00e4ndare.rb<\/b>:<\/span><\/p>\n
modul API\n  Modul V1\n    klass Anv\u00e4ndare < Grape::API\n      resurs :anv\u00e4ndare do\n        desc 'Returnera en lista med anv\u00e4ndare'\n        get do\n          Anv\u00e4ndare.alla\n        slut\n\n        desc 'Returnera en specifik anv\u00e4ndare'\n        params do\n          kr\u00e4ver :id, typ: Integer, desc: "Anv\u00e4ndar-ID\n        slut\n        route_param :id do\n          get do\n            User.find(params[:id])\n          end\n        slut\n\n        desc 'Skapa en anv\u00e4ndare'\n        parametrar do\n          kr\u00e4ver :namn, typ: String, desc: 'Anv\u00e4ndarnamn'\n          kr\u00e4ver :email, typ: String, desc: 'Anv\u00e4ndarens e-postadress'\n        slut\n        post g\u00f6r\n          Anv\u00e4ndare.skapa!({\n            namn: params[:namn],\n            e-post: params[:e-post]\n          })\n        slut\n\n        desc 'Uppdatera en anv\u00e4ndare'\n        parametrar do\n          kr\u00e4ver :id, typ: Integer, desc: "Anv\u00e4ndar-ID\n          kr\u00e4ver :namn, typ: String, desc: "Anv\u00e4ndarens namn\n          kr\u00e4ver :email, typ: String, desc: "Anv\u00e4ndarens e-post\n        slut\n        put ':id' do\n          anv\u00e4ndare = Anv\u00e4ndare.find(params[:id])\n          user.update({\n            namn: params[:namn],\n            e-post: params[:e-post]\n          })\n        slut\n\n        desc 'Ta bort en anv\u00e4ndare'\n        parametrar do\n          kr\u00e4ver :id, typ: Integer, desc: "Anv\u00e4ndar-ID\n        slut\n        ta bort ':id' do\n          User.find(params[:id]).destroy\n        end\n      slut\n    slut\n  slut\nslut\n<\/pre>\n
Montering av API<\/b><\/p>\n
F\u00f6r att ansluta till API:et m\u00e5ste du uppdatera din <\/span>config\/routes.rb:<\/b><\/p>\n
Rails.application.routes.draw g\u00f6r
<\/span>  mount API::Base => '\/'
<\/span>slutet<\/span><\/pre>\n
<\/p>\n
Skapa anv\u00e4ndarmodellen<\/b><\/h3>\n
F\u00f6r att st\u00f6dja anv\u00e4ndarens slutpunkter, skapa en User-modell:<\/span><\/p>\n
rails generate model Anv\u00e4ndarnamn:str\u00e4ng email:str\u00e4ng
<\/span>skenor db:migrera<\/span><\/pre>\n
<\/p>\n
Testning av API:et<\/b><\/h3>\n
Starta din Rails-server:<\/span><\/p>\n
R\u00e4ls server<\/span><\/pre>\n
<\/p>\n
Du kan nu testa dina API-slutpunkter med hj\u00e4lp av ett verktyg som <\/span>krulla<\/span> eller Postman. H\u00e4r \u00e4r n\u00e5gra exempel p\u00e5 f\u00f6rfr\u00e5gningar:<\/span><\/p>\n
H\u00e4mta alla anv\u00e4ndare:<\/b>
<\/span><\/p>\n
curl http:\/\/localhost:3000\/v1\/users<\/span><\/pre>\n
<\/p>\n
H\u00e4mta en specifik anv\u00e4ndare:<\/b>
<\/span><\/p>\n
curl http:\/\/localhost:3000\/v1\/users\/1<\/span><\/pre>\n
<\/p>\n
Skapa en ny anv\u00e4ndare:<\/b>
<\/span><\/p>\n
curl -X POST http:\/\/localhost:3000\/v1\/users -d \"name=John Doe&email=johndoe@example.com\"<\/span><\/pre>\n
Uppdatera en anv\u00e4ndare:<\/b>
<\/span><\/p>\n
curl -X PUT http:\/\/localhost:3000\/v1\/users\/1 -d \"name=Jane Doe&email=janedoe@example.com\"<\/span><\/pre>\n
<\/p>\n
Ta bort en anv\u00e4ndare:<\/b>
<\/span><\/p>\n
curl -X DELETE http:\/\/localhost:3000\/v1\/users\/1<\/span><\/pre>\n
<\/p>\n
Slutsats<\/b><\/h2>\n
Att anv\u00e4nda Grape med Ruby on Rails ger en kraftfull kombination f\u00f6r att bygga RESTful API:er. Grapes l\u00e4ttviktiga och flexibla natur g\u00f6r det enkelt att definiera och hantera API-slutpunkter, medan Rails hanterar den underliggande infrastrukturen. I det h\u00e4r exemplet demonstreras ett grundl\u00e4ggande CRUD-API f\u00f6r anv\u00e4ndarhantering, som visar hur man konfigurerar och anv\u00e4nder Grape inom en Rails ans\u00f6kan<\/a>. Med denna grund kan du ut\u00f6ka API:et till att omfatta mer komplexa funktioner och integrera det med andra tj\u00e4nster.<\/span><\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t<\/div>\n\t\t  
\r\n        
relaterade inl\u00e4gg<\/div>\r\n    
\r\n\r\n            
\r\n            
\r\n    \r\n\r\n      \"Offliberty\r\n\r\n    <\/a>\r\n  <\/div>\r\n\r\n  \r\n        Vad \u00e4r Offliberty Ruby Gem och hur fungerar den?  <\/a>\r\n\r\n        <\/div>\r\n              
\r\n            
\r\n    \r\n\r\n      \"Rails\r\n\r\n    <\/a>\r\n  <\/div>\r\n\r\n  \r\n        Rails link_to Metod: Den kompletta guiden med exempel  <\/a>\r\n\r\n        <\/div>\r\n              
\r\n            
\r\n    \r\n\r\n      \"Bygg\r\n\r\n    <\/a>\r\n  <\/div>\r\n\r\n  \r\n        Hur man bygger en skalbar SaaS-plattform med Ruby on Rails  <\/a>\r\n\r\n        <\/div>\r\n              
\r\n            
\r\n    \r\n\r\n      \"Ruby\r\n\r\n    <\/a>\r\n  <\/div>\r\n\r\n  \r\n        Ruby Regex Match Guide (2026) med exempel  <\/a>\r\n\r\n        <\/div>\r\n      \r\n  <\/div>\r\n\r\n