Commencez
Base de services Web REST
Suggérer des modifications
PDF
Representational State Transfer (REST) est un style qui permet de créer des applications Web distribuées. Lorsqu'il est appliqué à la conception d'une API de services Web, il établit un ensemble de technologies pour l'exposition des ressources basées sur serveur et la gestion de leur état. Il utilise des protocoles et des normes standard traditionnels pour offrir une base flexible d'administration des clusters ONTAP.
|
Alors QUE REST établit un ensemble commun de technologies et de bonnes pratiques, les détails de chaque API peuvent varier en fonction des choix effectués lors du développement. Il est important de connaître les caractéristiques de conception de l'API REST de ONTAP avant de l'utiliser avec un déploiement en direct. |
Ressources et représentation d'état
Les ressources sont les composants de base d'un système basé sur le Web. Lors de la création d'une application de services Web REST, les premières tâches de conception incluent :
-
Identification des ressources système ou serveur
Chaque système utilise et gère les ressources. Une ressource peut être un fichier, une transaction commerciale, un processus ou une entité administrative. L'une des premières tâches de conception d'une application basée sur des services Web REST consiste à identifier les ressources.
-
Définition des États de ressource et des opérations d'état associées
Les ressources se trouvent toujours dans un des États finis. Les États, ainsi que les opérations associées utilisées pour affecter les changements d'état, doivent être clairement définis.
Terminaux URI
Chaque ressource REST doit être définie et mise à disposition à l'aide d'un schéma d'adressage bien défini. Les noeuds finaux où les ressources sont situées et identifiées utilisent un URI (Uniform Resource identifier). L'URI fournit un cadre général pour créer un nom unique pour chaque ressource du réseau. L'URL (Uniform Resource Locator) est un type d'URI utilisé avec les services Web pour identifier et accéder aux ressources. Les ressources sont généralement exposées dans une structure hiérarchique similaire à un répertoire de fichiers.
Messages HTTP
Le protocole HTTP (Hypertext Transfer Protocol) est le protocole utilisé par le client et le serveur de services Web pour échanger des messages de requête et de réponse sur les ressources. Dans le cadre de la conception d'une application de services Web, les méthodes HTTP sont mappées aux ressources et aux actions de gestion d'état correspondantes. Le HTTP est sans état. Par conséquent, pour associer un ensemble de requêtes et de réponses associées dans le cadre d'une transaction, des informations supplémentaires doivent être incluses dans les en-têtes HTTP des flux de données de requête et de réponse.
Formatage JSON
Bien que les informations puissent être structurées et transférées de plusieurs façons entre un client de services Web et un serveur, l'option la plus populaire est JavaScript Object notation (JSON). JSON est une norme de l'industrie qui représente les structures de données simples en texte brut et permet de transférer les informations d'état décrivant les ressources. L'API REST de ONTAP utilise JSON pour formater les données présentes dans le corps de chaque requête et réponse HTTP.
Transaction standard d'API REST
Chaque transaction API se compose d'une requête HTTP et de la réponse associée. Cette illustration montre comment récupérer la version du logiciel ONTAP utilisé par le cluster.
La demande envoyée par le client au serveur comprend les éléments suivants :
-
OBTENIR verb
-
Chemin d'URL du cluster
-
Paramètre requête (champs)
-
En-têtes de demande, autorisation comprise
La réponse envoyée du serveur au client est constituée des éléments suivants :
-
Code d'état 200
-
En-têtes de réponse
-
Corps de réponse contenant la version du logiciel du cluster