UML / API : How to model a RESTful API

rest api symfony uml api-platform.com
Fatimaezzahra Rarhibou picture Fatimaezzahra Rarhibou · May 15, 2017 · Viewed 23.5k times · Source

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!

Answer

Fatimaezzahra Rarhibou picture Fatimaezzahra Rarhibou · May 17, 2017

So the solution to my problem was a bit of all of the following :

https://www.ibm.com/developerworks/rational/library/design-implement-restful-web-services/ : I concluded from this that, although it's difficult to model a restful api in a class diagram (since it's basically just a bunch of methods), consider the classes like "Resources", add the methods (basically the HTTP methods), and the paths to each resource.

This was also of huge help:

Another (simpler) way was to use tools like Pikturr, which transform your Swagger into a UML diagram.

Softwares for designing REST APIs :

  • Visual Paradigm
  • IBM Rational Software Architect

I hope this helps.

Related questions

Uploading image file through API using Symfony2 & FOSRESTBundle

I have been coding an API for a photo sharing app like Instagram using Symfony2, FOSRESTBundle, and Vichuploader for file uploads. I'm able to work around GET and POST requests, but I can't find an example of how to attach …

Read More
How do I make calls to a REST API using C#?

This is the code I have so far: using System; using System.Collections.Generic; using System.Linq; using System.Text; using System; using System.Net.Http; using System.Web; using System.Net; using System.IO; namespace ConsoleProgram { public class Class1 { …

Read More
How do you set the Content-Type header for an HttpClient request?

I'm trying to set the Content-Type header of an HttpClient object as required by an API I am calling. I tried setting the Content-Type like below: using (var httpClient = new HttpClient()) { httpClient.BaseAddress = new Uri("http://example.com/"); httpClient.DefaultRequestHeaders.…

Read More