2010-11-06 25 views

回答

1

我想你問,因爲想溝通或文件您的API?我可以去sequence-diagrams。在大多數情況下,你不需要完全符合UML2「符合語法」。通常白板上的塗鴉足以傳達你的Restful api。到目前爲止,我還沒有看到過使用UML工具完全維護Restful api的情況。

另一種選擇,以快速/骯髒圖什麼也有助於記錄通過HTTP RESTful的API使用HTTP片段:


Pattern: 
> METHOD RESOURCE-URL 
>...REQUEST-RESOURCE-PAYLOAD (if there) 
< RESPONSE-CODE 
< RESPONSE-RESOURCE-PAYLOAD (if there) 


Examples: 

> GET /items/123 
< 200 

> POST /items 
> ...payload(resource-representation) 
< 201 
 

短文本式通信工程,因爲HTTP統一接口(魔幻三角的非常漂亮:方法,resource-url,資源表示)。

相關問題