Blame view

api.raml 1.32 KB
ea2f57e1   Geoffrey PREUD'HOMME   Test API
1
2
3
4
  #%RAML 1.0
  title: API d'Etunicorn
  baseUri: https://etunicorn.plil.net/{version}/
  version: v1
509e1d6e   Geoffrey PREUD'HOMME   API: Login
5
  /login:
b8824e3a   Geoffrey PREUD'HOMME   Avec le login, ce...
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
    post:
      description: Instancie une nouvelle connexion
      queryParameters: 
        login:
          displayName: Login Polytech
          type: string
          required: true
        password:
          displayName: Mot de passe Polytech
          type: string
          required: false
      responses: 
        200:
          description: Authentification réussie
          body:
            application/json:
              example:
                {
                  "token": "ooT6zahdura7vaethuiph1ugiph6co",
                  "expire": 1485607703
                }
        401:
          description: Authentication échouée
ea2f57e1   Geoffrey PREUD'HOMME   Test API
29
  /personne:
509e1d6e   Geoffrey PREUD'HOMME   API: Login
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
    get:
     description: Obtenir la liste des persones
     responses: 
       200:
         body:
            application/json:
              example:
                [
                  {
                    "idPersonne": 42,
                    "idCarte": "AAAAA",
                    "naissance": "1997-02-14",
                    "solde": 1337,
                    "loginPoly": "gbontoux"
                  }
                ]
    put:
      description: Ajoute un nouvel étudiant
      queryParameters:
        idCarte:
          displayName: ID de la carte NFC
          type: string
          required: false
        naissance:
          displayName: Date de naissance