@geolens/ sdk (TypeScript) (英语)
自动生成类型SDK 地球轨道 API (英语).
Apache -2.0 许可。 土著 fetch 客户端+打出的请求/响应接口+ Bearer-token + API- key 认证帮助器. 需要节点18+(或任何运行时间) fetch) (中文(简体) ).
见 页面存档备份,存于互联网档案馆. docs.getgeolens.com 用于安装、再生和版本夹政策.
安装
npm install @geolens/sdk
一揽子措施仅是无害环境管理(import没有 require) (中文(简体) ).
快速启动
import { createGeolensClient } from '@geolens/sdk';
const sdk = createGeolensClient({
// The deployed API is served under /api, so include that suffix in baseUrl.
baseUrl: 'https://geolens.example.com/api',
bearerToken: '...',
});
// See docs.getgeolens.com for endpoint usage examples.
错误
生成呼叫返回 { data, error, response } 别扔出HTTP
错误状态 . error 是解析 application/problem+json 机构
(单位:千美元)type, (中文(简体) ), title, (中文(简体) ), status, (中文(简体) ), detail:
import { createGeolensClient, getSingleDatasetDatasetsDatasetIdGet } from '@geolens/sdk';
const sdk = createGeolensClient({ baseUrl: 'https://geolens.example.com/api', apiKey: '...' });
const { data, error, response } = await getSingleDatasetDatasetsDatasetIdGet({
client: sdk.client,
path: { dataset_id: '00000000-0000-0000-0000-000000000000' },
});
if (error) {
console.error(response.status, error.detail);
}
与 throwOnError: true 调用抛出解析出的错误正文, 普通对象
而不是一个 Error 举个例子.
createGeolensClient() 返回该呼叫的客户端范围( e)sdk.client) (中文(简体) ).
把它明确传递给每一个生成的终点呼叫—— { client: sdk.client }
——当您在同一过程中构建多个客户端(例如,一个)
每个请求在服务器中,所以并行调用者不能干预每个请求
其他费用。 选择 client 从生成的呼叫返回到共享
最新的全进程默认值 createGeolensClient() 调用
配置; 单客户端脚本的默认可以, 但是是
最后呼叫者胜过同时期客户.
重定向
当重定向离开 GeoLens 来源时, 当 COG 下载时发生
从对象存储服务, SDK 不发送证书或客户端头
在这里。 仅 Range 编辑 If-* 附带条件的标头也随之而来.
在节点,SDK跟随GET 和头方向自己。 一个跳出
GeoLens 来源于全球 fetch,不是客户的 fetch 选项
(一个带有 undici 的代理集) setGlobalDispatcher 页:1.
在浏览器中,如果重定向的目标无法读取,则请求会携带
Authorization 或者说 X-API-Key 失败 RedirectError,以及任何其他
请求会再次发送,没有 cookie, 以便浏览器遵循 。 要下载
a COG there, mint a 下载符号(POST /auth/download-token/{dataset_id}(中文(简体) )
获取 /datasets/{dataset_id}/download/cog?token=... 没有证书.
这适用于默认 redirect: 'follow'设置 redirect: 'manual' 或者说
'error',每个呼叫或客户,你得到什么 fetch 给予:
重新定向未跟踪返回, 或 a TypeError。 。 。 .