Siirry dokumentaation sisältöön
Dataset APIDocs
Takaisin sivustolle
FIEN

Generoidut SDK:t

Käytä sopimuksesta generoituja clientteja tuotantoa, sandboxia tai determinististä paikallista feikkidataa vasten.

9 min Päivitetty 2026-08-15Docs-versio 1.0
Tässä oppaassa
  1. 122 generoitua kielipakettia
  2. 2OpenAPI on totuuden lähde
  3. 3TypeScript- ja Python-pika-aloitukset feikkidatalla
  4. 4Sopimus- ja natiivi E2E-varmennus
Tässä oppaassa
  1. 122 generoitua kielipakettia
  2. 2OpenAPI on totuuden lähde
  3. 3TypeScript- ja Python-pika-aloitukset feikkidatalla
  4. 4Sopimus- ja natiivi E2E-varmennus

Yksi sopimus, generoidut paketit

Jokainen Dataset API SDK generoidaan openapi/dataset-api-v1.json-tiedostosta frameworkin lukitulla OpenAPI Generator -versiolla. Endpoint-metodit, mallit, todennus, perusosoitteet ja pakettiversiot seuraavat näin kanonista API-sopimusta käsin ylläpidetyn kopion sijaan.

Alla olevat pakettisivut luetaan generoidusta Dataset API -manifestista. Vanhentunut OpenAPI-tilannekuva tai generoitu tiedosto kaataa SDK-tarkistukset.

ArtefaktiTakuu
GENERATION.jsonSitoo paketin OpenAPI-versioon, spesifikaation SHA-256-tiivisteeseen ja generaattoriversioon
SDK_VERIFICATION_PLAN.jsonListaa sopimuksesta johdetut operaatiot ja vaaditut tarkistukset
FAKE_API.mdDokumentoi jaetun produktitietoisen feikki-endpointin ja demotunnisteen
manifest.jsonTallentaa jokaisen generoidun tiedoston tiivisteen ja kaikki 22 kielikohdetta

TypeScript feikkidataa vasten

Asenna paikallisesti generoitu paketti
npm install ./sdks/generated/dataset-api/typescript
TypeScript
import { Configuration, DatasetsApi } from "@datasetapi/sdk";

const config = new Configuration({
  basePath: "http://localhost:3000/api/fake/dataset-api/v1",
  accessToken: process.env.DATASET_API_KEY,
});

const catalog = await new DatasetsApi(config).listDatasets({ xAPIVersion: "1" });
console.log(catalog.data[0].latest_release);

Python feikkidataa vasten

Asenna paikallisesti generoitu paketti
python -m pip install ./sdks/generated/dataset-api/python
Python
import asyncio
import os
import dataset_api

async def main():
    config = dataset_api.Configuration(
        host="http://localhost:3000/api/fake/dataset-api/v1",
        access_token=os.environ["DATASET_API_KEY"],
    )
    async with dataset_api.ApiClient(config) as client:
        catalog = await dataset_api.DatasetsApi(client).list_datasets(x_api_version="1")
        print(catalog.data[0].latest_release)

asyncio.run(main())

Deterministinen feikki-API

Käynnistä Dataset API -sivu paikallisesti, aseta DATASET_API_KEY kertakäyttöiseen paikalliseen testitunnisteeseen ja käytä osoitetta http://localhost:3000/api/fake/dataset-api/v1. HTTP-feikki käyttää samaa Dataset Builder -adapteria kuin preview-käyttöliittymä ja tarjoaa vakailla fixtureilla katalogi-, release-, kysely-, build-, peruutus-, lataus- ja health-operaatiot.

Feikki on tarkoitettu integraatiokehitykseen, esimerkkeihin ja SDK-varmennukseen. Se ei korvaa sandboxin suorituskykytestausta tai tuotannon datan laatutestausta.

Nollaa deterministiset fixturet
npm run sdk:fake:reset -- --product dataset-api

Generoi ja varmista

  1. 1
    Muuta kanonista OpenAPI-sopimusta
  2. 2
    Generoi kaikki määritetyt produkti- ja kielipaketit komennolla npm run sdk:generate
  3. 3
    Varmista tallennetun tuloksen ajantasaisuus komennolla npm run sdk:check
  4. 4
    Aja npm run sdk:e2e -- --product dataset-api --language typescript ja toista Pythonille
  5. 5
    Aja operaatioiden E2E-sarja ennen paketin julkaisua
Oliko tästä sivusta apua?