How to show attribute as "readonly" in UML?

rest model uml class-diagram
nipeco picture nipeco · Jan 26, 2017 · Viewed 7.5k times · Source

I want to describe some models of an API in a diagram. Is there a standard how to mark an attribute as readonly? These attributes are set by the system and cannot be modified by the API consumer.

Currently I abuse the class diagram notation for private and public attributes. But I am not satisfied with this.

Thanks for your thoughts :)

Answer

qwerty_so picture qwerty_so · Jan 26, 2017

The usual way when you interface coding you would make private properties and use getter/setter operations. You could also leave it on a more abstract level and simply stereotype them with <<readonly>> or <<r/o>>. And finally you could use an appropriate getter method.

enter image description here

Edit The current UML 2.5 spec states on p. 17

Attributes: each specified by its name, type, and multiplicity, and any additional properties such as {readOnly}.

An example on how to use this is found on p. 113:

enter image description here

Related questions

How do I POST JSON data with cURL?

I use Ubuntu and installed cURL on it. I want to test my Spring REST application with cURL. I wrote my POST code at the Java side. However, I want to test it with cURL. I am trying to post …

Read More
PUT vs. POST in REST

According to the HTTP/1.1 Spec: The POST method is used to request that the origin server accept the entity enclosed in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line In other words, …

Read More
What exactly is RESTful programming?

What exactly is RESTful programming?

Read More