校验 manifest
curl --request POST \
--url https://api-datahub.bazhuayu.com/v1/data-apps/validate \
--header 'Content-Type: application/json' \
--data '
{
"manifest": "<string>",
"files": {},
"secrets": {}
}
'import requests
url = "https://api-datahub.bazhuayu.com/v1/data-apps/validate"
payload = {
"manifest": "<string>",
"files": {},
"secrets": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({manifest: '<string>', files: {}, secrets: {}})
};
fetch('https://api-datahub.bazhuayu.com/v1/data-apps/validate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({manifest: '<string>', files: {}, secrets: {}})
};
fetch('https://api-datahub.bazhuayu.com/v1/data-apps/validate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-datahub.bazhuayu.com/v1/data-apps/validate"
payload := strings.NewReader("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-datahub.bazhuayu.com/v1/data-apps/validate")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {}\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-datahub.bazhuayu.com/v1/data-apps/validate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'manifest' => '<string>',
'files' => [
],
'secrets' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api-datahub.bazhuayu.com/v1/data-apps/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {}\n}"
response = http.request(request)
puts response.read_bodyusing RestSharp;
var options = new RestClientOptions("https://api-datahub.bazhuayu.com/v1/data-apps/validate");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {}\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {}\n}")
val request = Request.Builder()
.url("https://api-datahub.bazhuayu.com/v1/data-apps/validate")
.post(body)
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute()false{
"valid": true,
"errors": [
{
"path": "<string>",
"message": "<string>"
}
],
"card": {}
}发布与运营
校验 manifest
对一份 manifest 做完整校验,不落库,返回问题清单与预览卡片。
POST
/
v1
/
data-apps
/
validate
校验 manifest
curl --request POST \
--url https://api-datahub.bazhuayu.com/v1/data-apps/validate \
--header 'Content-Type: application/json' \
--data '
{
"manifest": "<string>",
"files": {},
"secrets": {}
}
'import requests
url = "https://api-datahub.bazhuayu.com/v1/data-apps/validate"
payload = {
"manifest": "<string>",
"files": {},
"secrets": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({manifest: '<string>', files: {}, secrets: {}})
};
fetch('https://api-datahub.bazhuayu.com/v1/data-apps/validate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({manifest: '<string>', files: {}, secrets: {}})
};
fetch('https://api-datahub.bazhuayu.com/v1/data-apps/validate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-datahub.bazhuayu.com/v1/data-apps/validate"
payload := strings.NewReader("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-datahub.bazhuayu.com/v1/data-apps/validate")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {}\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-datahub.bazhuayu.com/v1/data-apps/validate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'manifest' => '<string>',
'files' => [
],
'secrets' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api-datahub.bazhuayu.com/v1/data-apps/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {}\n}"
response = http.request(request)
puts response.read_bodyusing RestSharp;
var options = new RestClientOptions("https://api-datahub.bazhuayu.com/v1/data-apps/validate");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {}\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {}\n}")
val request = Request.Builder()
.url("https://api-datahub.bazhuayu.com/v1/data-apps/validate")
.post(body)
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute()false{
"valid": true,
"errors": [
{
"path": "<string>",
"message": "<string>"
}
],
"card": {}
}端点
POST https://api-datahub.bazhuayu.com/v1/data-apps/validate
Authorization: Bearer <API Key>)。
两阶段发布的第一阶段:结构、跨块规则、自发布护栏、code 包检查与文件名检查的完整校验,与发布时用的是同一个判定,返回问题清单和预览卡片。对错判定唯一以本端点为准,不要照文档里的字段表自行判断。
请求
请求体
string
必填
manifest 原文,YAML 或 JSON 字符串。
object
随附文件,键为相对路径,值为文本内容(code 型或带 README 时使用)。
object
随附的密钥名到明文的映射;校验端点不会存储它们。
示例请求
curl -X POST \
-H "Authorization: Bearer $BAZHUAYU_API_KEY" \
-H "Content-Type: application/json" \
-d '{"manifest": "spec_version: \"0.2\"\nidentity:\n app_name: reviews-query\n name: 商品评论查询\n …"}' \
"https://api-datahub.bazhuayu.com/v1/data-apps/validate"
响应
200 成功
{
"data": {
"valid": false,
"errors": [
{
"path": "$",
"message": "'identity' is a required property"
},
{
"path": "$",
"message": "'input' is a required property"
},
"…"
],
"card": null
}
}
data 字段中,其内容如下。
boolean
必填
是否通过。
object
通过时的预览卡片,未通过为
null。错误
| HTTP | code | category | 说明 |
|---|---|---|---|
| 401 | unauthorized | forbidden | 缺少或无效的 API Key。 |
{"error": {code, category, message, retryable}},见错误。
