Skip to content

快速上手

本指南将向你展示如何初始化 Loongship 数据 SDK,并发起你的第一次 API 请求。

初始化

首先,引入 createLoongshipDataApi 并使用你的 base URL 和秘钥(key)初始化客户端。

typescript
import { createLoongshipDataApi } from 'loongship-data';

const client = createLoongshipDataApi({
  baseURL: 'https://api.example.com', // 如果使用默认地址可以不传
  key: 'your-api-key'
});

使用模块发起请求

初始化完成后,你可以通过访问客户端上的不同模块来获取数据。例如,使用 ship(船舶)模块查询船舶详情:

typescript
async function fetchShipData() {
  try {
    const data = await client.ship.detail({ mmsi: 123456789 });
    console.log(data);
  } catch (error) {
    console.error('获取船舶数据失败:', error);
  }
}

fetchShipData();

查看左侧的 API 参考,了解所有可用模块和方法的完整列表。