Difference between revisions of "OpenAPI OAR"

From air
Jump to navigation Jump to search
Line 1: Line 1:
 
=Objectif=
 
=Objectif=
 
Il s'agit de créer une REST API suivant la spécification [https://en.wikipedia.org/wiki/OpenAPI_Specification OpenAPI] pour le gestionaire de tâches et de ressources [http://oar.imag.fr/ OAR].
 
Il s'agit de créer une REST API suivant la spécification [https://en.wikipedia.org/wiki/OpenAPI_Specification OpenAPI] pour le gestionaire de tâches et de ressources [http://oar.imag.fr/ OAR].
Cette spécification permet de produire et maintenir des services web robustes et bien définier. Par exemple l'orchestrateur de containers Kubernetes dispose d'un API suivant cette spécification https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-specification
+
Cette spécification permet de produire et maintenir des services web robustes et bien définier. Par exemple l'orchestrateur de containers Kubernetes dispose d'une API suivant cette spécification https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-specification
   
 
Le logiciel OAR dispose déjà d'une Rest API qui servira de base de travail:
 
Le logiciel OAR dispose déjà d'une Rest API qui servira de base de travail:

Revision as of 13:33, 14 January 2021

Objectif

Il s'agit de créer une REST API suivant la spécification OpenAPI pour le gestionaire de tâches et de ressources OAR. Cette spécification permet de produire et maintenir des services web robustes et bien définier. Par exemple l'orchestrateur de containers Kubernetes dispose d'une API suivant cette spécification https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-specification

Le logiciel OAR dispose déjà d'une Rest API qui servira de base de travail:

Les contraintes technologigues

Plan de travail et indications

  • Prise en main de l'approche OpenAPI (modification de l'exemple Petstore et génération de du server)
  • Utilisation d'un éditeur de specfication d'OpenAPI (https://github.com/swagger-api/swagger-editor ?)
  • Generatoion d'un (mock) server Python Flash via le générateur openapi-generator
  • étude problématique d'authentification, utilisation de la méthode HTTP patch
  • étude le l'API / choix de Kubernetes

Autres