REST declaration
#1
Salutations,

j'espère que la formulation de ma question sera claire: j'ai un jeu web, sur un serveur. Donc, je peux contacter le serveur avec des URLs, et pour chaque URL, donner d'éventuels paramètres GET ou POST, avec également un verbe HTTP et éventuellement des formats de retours possibles (des HTTP Accept valides).

Donc, un genre de REST généralisé.

Quel format standard me permettrait de déclarer la liste de ces URLs avec, pour chacune, les verbes HTTP acceptés, et les paramètres GET/POST/HTTP Accept correspondant, ainsi que la description du endpont?

Donc, en gros, quel format standard utiliser pour documenter un serveur REST?

La doc d'OVH par exemple est bien foutu dans le style https://api.ovh.com/console/
Est-ce qu'il existe un outil général pour faire ce genre de présentation, et si oui, quel format prend-il en entrée?
Répondre
#2
Est-ce que c'est pas le genre de truc qu'on fait avec Swagger ?

Ou alors j'ai pas compris ta question.
Répondre
#3
Pareil ce que tu décris me fait penser à Swagger UI.
Répondre
#4
En effet, ça m'a l'air pas dégueux comme solution. Je tâcherai de voir comment l'intégrer sur Variispace plus tard.

Merci !
Répondre
#5
Yep Swagger, c’est ce qu’il te faut.

Je m’etais tâté à faire une API Rest pour ma version application mobile qui serait venue questionner mon serveur Symfony. Et l’outil de documentation que je comptais utiliser (NelmioApiDocBundle) implémentait Swagger. J’ai pu tester, c’etait Nickel.

(Mais du coup j’utilise pas ça parce que mes applications mobiles vont être la même version que mon application web, encapsulée par cordova.js (PhoneGap). Du coup je ferais des requêtes de pages complètes.)
Répondre
#6
Ok, je vais voir ça

En tous cas, j'ai déjà trouvé la réponse à ma question initiale de format de déclaration de l'API: OpenAPI
Reste à l'implémenter et à la charger dans ce Swagger pour faire joli...

Merci !


J'ai drafté un truc, c'est plutôt bien fait, même s'il me faudra encore gérer proprement pas mal de trucs (les typages des réponses de retour, les codes d'erreur, les paramètres, etc)

https://app.swaggerhub.com/apis/Xenos/va...-api/x.x.x
Répondre




Utilisateur(s) parcourant ce sujet : 1 visiteur(s)