{"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":"quest-ce-que-lapi-de-repos","status":"publish","type":"post","link":"https:\/\/www.railscarma.com\/fr\/blog\/articles-techniques\/quest-ce-que-lapi-de-repos\/","title":{"rendered":"Qu'est-ce que l'API REST ?"},"content":{"rendered":"

API, abr\u00e9viation d'interface de programme d'application, est un ensemble de pratiques, de protocoles et d'outils permettant de cr\u00e9er des applications logicielles. Parfois, nous pouvons avoir besoin d\u2019une int\u00e9gration tierce pour notre application Web. Pour y parvenir, l\u2019API REST est une chose simple. L'avantage de l'API Rest sera ind\u00e9pendant du langage.<\/p>\n

REST (REpresentational State Transfer) est une architecture simple qui s'ex\u00e9cute sur HTTPS ou TLS. Le style REST souligne que les interactions entre les clients et les services sont am\u00e9lior\u00e9es gr\u00e2ce \u00e0 un nombre limit\u00e9 d'op\u00e9rations.<\/p>\n

La flexibilit\u00e9 est assur\u00e9e en attribuant aux ressources leurs propres indicateurs de ressources universelles (URI). \u00c9tant donn\u00e9 que chaque op\u00e9ration (GET, POST, PUT et DELETE) a une signification sp\u00e9cifique, REST \u00e9vite toute incertitude.<\/p>\n

Construire une API REST simple\u00a0:<\/h3>\n

L'API n'a besoin d'aucune vue car l'utilisateur n'interagit pas directement avec l'application. Nous sp\u00e9cifions simplement les donn\u00e9es que le tiers enverra.<\/p>\n

Il n'y aura aucune action d'affichage ou de modification car nous n'avons aucune vue ici. Pour chaque requ\u00eate, certaines donn\u00e9es seront renvoy\u00e9es avec le code d'\u00e9tat et le message d'\u00e9chec de r\u00e9ussite. Les donn\u00e9es peuvent \u00eatre au format json ou xml.<\/p>\n

Exigence\u00a0: gem 'rails-api'<\/p>\n

Lors de la cr\u00e9ation de l'application, cr\u00e9ez en tant que rails-api le nouveau [nom_application], afin d'\u00e9viter la vue, les ressources\/feuilles de style et les ressources\/javascript.<\/p>\n

Nous devons cr\u00e9er un espace de noms pour notre API, ce qui maintient notre code propre et maintient vos API ind\u00e9pendantes du reste de vos contr\u00f4leurs. Nous commen\u00e7ons par ajouter nos itin\u00e9raires.<\/p>\n

routes.rb<\/p>\n

espace de noms\u00a0:api do
\nressources\u00a0:\u00a0utilisateurs
\nfin<\/p><\/blockquote>\n

Il recherchera un UsersController dans app\/controllers\/api\/users_controller.rb<\/p>\n

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

fin<\/p>\n

J'esp\u00e8re que vous \u00eates tous familiers avec les op\u00e9rations CRUD simples, faites de m\u00eame ici, mais il n'y aura pas de vue, donc \u00e0 la place de la redirection, nous devons restituer certaines donn\u00e9es avec le code d'\u00e9tat.<\/p>\n

Par ex.<\/strong><\/p>\n

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

indice d\u00e9f
\n@users = Utilisateur.all
\nr\u00e9pondre_\u00e0 faire |format|
\nformat.json { rendu json\u00a0: @users }
\nformat.xml { rendu xml\u00a0: @users }
\nfin
\nfin<\/p>\n

d\u00e9finitivement d\u00e9truire
\nr\u00e9pondre_\u00e0 faire |format|
\nsi @user.destroy
\nformat.json { head :no_content, status: :Supprim\u00e9 avec succ\u00e8s }
\nformat.xml { head\u00a0:no_content, status\u00a0:\u00a0:\u00a0supprim\u00e9 avec succ\u00e8s }
\nautre
\nformat.json { render json\u00a0: @user.errors, statut\u00a0:\u00a0Impossible }
\nformat.xml { rendu xml\u00a0: @user.errors, statut\u00a0:\u00a0Impossible }
\nfin
\nfin
\nfin<\/p>\n

fin<\/p><\/blockquote>\n

De cette fa\u00e7on, nous pouvons cr\u00e9er une API REST.<\/p>\n

Si vous devez ajouter une nouvelle fonctionnalit\u00e9, toute modification apport\u00e9e \u00e0 votre API, vous pouvez cr\u00e9er une version de votre API.<\/p>\n

Versionnement de l'API<\/strong><\/p>\n

Dans routes.rb<\/p>\n

espace de noms\u00a0:api do<\/p>\n

espace de noms\u00a0:\u00a0v1 \u00e0 faire<\/p>\n

ressources\u00a0:\u00a0utilisateurs
\nfin
\nfin<\/p><\/blockquote>\n

Il recherchera un UsersController dans
\napp\/controllers\/api\/v1\/users_controller.rb<\/p>\n

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

fin<\/p>\n

Enfin, fournissez la documentation de l'API aux utilisateurs.<\/p>\n

Requ\u00eates API\u00a0:<\/p>\n

Liste des utilisateurs<\/p>\n

URL\u00a0: http:\/\/localhost:3000\/api\/users
\nm\u00e9thode\u00a0: OBTENIR<\/p><\/blockquote>\n

Suppression d'un utilisateur<\/p>\n

URL\u00a0: http:\/\/localhost:3000\/api\/users\/:id
\nm\u00e9thode\u00a0:\u00a0SUPPRIMER<\/p><\/blockquote>\n

RailsCarma, une soci\u00e9t\u00e9 Global Rails de marque et r\u00e9put\u00e9e qui fournit des services de d\u00e9veloppement RoR haut de gamme sur une d\u00e9cennie. Il fournit des solutions mises \u00e0 jour et de haut niveau pour tous les services RoR.<\/p>\n

Lire des articles similaires :<\/p>\n