如何使用 RAML 在 API 端点文档中显示绝对 URL?
How to show absolute URLs in API endpoint docs with RAML?
我正在使用 RAML 来记录我的 REST API。在 RAML 文档中,我在根级别
指定基数 URL
baseUri: http://api.example.org/api/{version}
version: v1
然后在文档的 API 端点部分,我指定它们相对于此基数的 URL,例如
/foo/bar:
get:
description: blah blah blah
当我 运行 raml2html
从 RAML 文档生成一个 HTML 页面时,相关的 URL /foo/bar
显示在文档中API 端点,但我更愿意显示绝对值 URL http://api.example.org/api/v1/foo/bar
,这可能吗?
raml2html
允许对整个文档包装器、每个资源和每个项目使用自定义模板。
在您的情况下,您希望自定义资源模板,然后将其与 -r custom-resource.handlebars
参数一起使用。
我正在使用 RAML 来记录我的 REST API。在 RAML 文档中,我在根级别
指定基数 URLbaseUri: http://api.example.org/api/{version}
version: v1
然后在文档的 API 端点部分,我指定它们相对于此基数的 URL,例如
/foo/bar:
get:
description: blah blah blah
当我 运行 raml2html
从 RAML 文档生成一个 HTML 页面时,相关的 URL /foo/bar
显示在文档中API 端点,但我更愿意显示绝对值 URL http://api.example.org/api/v1/foo/bar
,这可能吗?
raml2html
允许对整个文档包装器、每个资源和每个项目使用自定义模板。
在您的情况下,您希望自定义资源模板,然后将其与 -r custom-resource.handlebars
参数一起使用。