Best Way to Document a RESTful WebService

[LucB]

Hi All,

I was looking to give a detailed documentation on a RESTful WebService to my development team. I see that it is possible for SOAP WebServices but I don't see anywhere how to describe a RESLful one.

Any suggestions on that would be extremely appreciated.

Thanks in advance,
Luc

[qwerty]

How about a simple stereotype?

q.

[LucB]

How about a simple stereotype?

q.

Hi,

What do you mean by simple stereotype and what model are you suggesting?

Thanks very much for you answer.

[qwerty]

Maybe you should elaborate on what you mean with "describe a RESLful one".

If you want't to "describe" it, just attach a <RESTful> stereotype to the web service. If you want to show how it's modelled - this is a completely different story.

q.

[LucB]

Maybe you should elaborate on what you mean with "describe a RESLful one".

If you want't to "describe" it, just attach a <RESTful> stereotype to the web service. If you want to show how it's modelled - this is a completely different story.

q.

Yes that is what I want to do. What methods are exposed, what parameters should be passed and what is returned.

The WADL file of the WS does not go to that level of details.

For instance, for a POST method, I need a good description of the content,XML in this case, should be included in the body of the request.

Thanks,
Luc

[qwerty]

Well, I guess you will not have so much luck here with someone helping to model RESTful services. However, Google is your friend. There should be articles about that. This is nothing related to EA but UML in general.

q.

[LucB]

Well, I guess you will not have so much luck here with someone helping to model RESTful services. However, Google is your friend. There should be articles about that. This is nothing related to EA but UML in general.

q.

I understand. At least you gave me good hints.

Thanks very much for your help.
Luc