2015-05-14 42 views
1

我正在使用RAML來記錄我的REST API。在RAML文檔,我在根級如何使用RAML在API端點文檔中顯示絕對URL?

baseUri: http://api.example.org/api/{version} 
version: v1 

然後在文檔的API端點部分中指定的基本URL,我指定他們的URL相對於該鹼,例如

/foo/bar: 
    get: 
     description: blah blah blah 

當我運行raml2html生成從RAML文檔HTML頁面,相對URL /foo/bar在文檔的API端點顯示,但我更願意表現出絕對的URL http://api.example.org/api/v1/foo/bar代替,這是可能的?

回答

2

raml2html允許爲整個文檔包裝器,每個資源和每個項目使用自定義模板。

在您的情況下,您要自定義資源模板,然後將其與-r custom-resource.handlebars參數配合使用。

+0

是否有提供自定義模板的示例/教程? –

+0

您可以使用現有模板作爲示例:https://github.com/kevinrenskers/raml2html/tree/master/lib –