读取模板文件
功能介绍
该接口可以用于模板作者或模板维护人读取模板文件内容。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/templates/{template_id}/files
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
template_id |
是 |
String |
模板ID，通过查询模板列表接口可获取相应的模板ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
file_path |
是 |
String |
文件相对路径，基于当前根目录的相对文件路径，例如获取HELP.md文件内容，则文件相对路径为“template-resources/file/HELP.md”。 |
type |
否 |
String |
读取文件来源，缺省值为“source-pachage”。 枚举值：
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Language |
否 |
String |
语言类型，缺省值为“zh-cn”。 枚举值：
|
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
content |
String |
文件内容（返回的文件内容为encoding指定的编码格式编码后的内容）。 |
encoding |
String |
内容编码格式(固定base64)。 |
file_name |
String |
文件名。 |
file_path |
String |
文件相对路径。 |
file_type |
String |
文件类型。 |
请求示例
GET https://{endpoint}/v1/template/0633650ed8a7e69212eed4c348eb6b8d/files?file_path=src/%2Ftest%2Fjava%2FTest.java
响应示例
状态码： 200
OK
{
"content" : "cHVibGljIGNsYXNzIFRlc3Qgewp9",
"encoding" : "base64",
"file_name" : "Test.java",
"file_path" : "src/test/java/Test.java",
"file_type" : "text/plain; charset=utf-8"
}
状态码： 400
Bad Request
{
"error_code" : "DEVSTAR.1001",
"error_msg" : "file_path : 非法参数"
}
状态码： 401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "认证信息过期"
}
状态码： 403
Forbidden
{
"error_code" : "DEVSTAR.1034",
"error_msg" : "无操作权限"
}
状态码： 404
Not Found
{
"error_code" : "DEVSTAR.1039",
"error_msg" : "文件不存在"
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。
