UML / API : How to model a RESTful API

Viewed 33329

I need to create a UML class diagram and a use case diagram for a RESTFul API that I developed using API Platform and Symfony 3.2 (backend) and Ionic 2 (frontend). But i dont exactly know how to describe the structure of my backend API through the class diagram.

If anyone has any idea or could be of any help, i'd truly appreciate it. Thank you!

4 Answers

It is too late, but this is another approach.

If you do not know about Visual Paradigm you can give it a try.

You can use this content, Visual Paradigm - How to Design REST API with UML?. It is easy, to represent your REST API. I prefer Postman Collections BTW (it is not UML).

But if you are doing some other kinds UML artifacts for documentation purposes. Well, Visual Paradigm gives you a bunch of UML diagrams to do that. So you keep that ecosystem of diagrams.

See ya.

The real answer for the question is to use an UML Component Diagram, since its very purpose is to model architectures based on services. Check this link for more info: https://diagramasuml.com/componentes/

Related