UML / API: comment modéliser une API RESTful
J'ai besoin de créer un diagramme de classe UML et un diagramme de cas d'utilisation pour une API RESTFul que j'ai développée en utilisant API Platform et Symfony 3.2 (backend) et Ionic 2 (frontend). Mais je ne sais pas exactement comment décrire la structure de mon API backend à travers le diagramme de classes.
Si quelqu'un a une idée ou pourrait être utile, je l'apprécierais vraiment. Je vous remercie!
Donc, la solution à mon problème était un peu de tout ce qui suit:
https://www.ibm.com/developerworks/rational/library/design-implement-restful-web-services/: J'en ai conclu que, bien qu'il soit difficile de modéliser une API reposante dans un diagramme de classes (car il s'agit essentiellement d'un tas de méthodes), considérez les classes comme "Resources", ajoutez les méthodes (essentiellement les méthodes HTTP), et les chemins d'accès à chaque ressource.
Cela a également été d'une grande aide:
Une autre façon (plus simple) était d'utiliser des outils comme Pikturr, qui transforment votre Swagger en diagramme UML.
Logiciels de conception REST:
- Paradigme visuel
- Architecte logiciel IBM Rational
J'espère que ça aide.
Api Platform génère automatiquement une documentation Swagger pour votre API à l'URL http://localhost/docs.json.
Vous pouvez générer un diagramme UML à partir de la documentation Swagger à l'aide d'outils tels que https://github.com/nrekretep/pikturr