Erste Schritte

In diesem Thema wird die Installation und Konfiguration des SDK für TypeScript und JavaScript beschrieben.

Um das Oracle Cloud Infrastructure-SDK für TypeScript und JavaScript in Ihrem Projekt zu verwenden, importieren Sie einen beliebigen Service aus ./oci-typescript-sdk/index.ts. Beispiel:

// Container Engine

export import containerengine = require("oci-containerengine");

// Core

export import core = require("oci-core");

// Database

export import database = require("oci-database");

SDK von GitHub herunterladen

Sie können das TypeScript- und JavaScript-SDK als ZIP-Archiv von GitHub herunterladen. Es enthält das SDK, alle Abhängigkeiten, Dokumentation und Beispiele.

Mit yum installieren

Wenn Sie Oracle Linux 7 oder 8 verwenden, können Sie das OCI-SDK für TypeScript und JavaScript mit Yum installieren.

Für Oracle Linux 8:

sudo yum module enable nodejs:14 # for node 16 run: sudo yum module enable nodejs:16
sudo yum install oci-typescript-sdk

Für Oracle Linux 7:

Das OS Management-System muss für die Compute-Instanz aktiviert sein. Weitere Informationen finden Sie in der Dokumentation zu OS Management.

Knotenversion 14 oder 16 muss von OS Management in die Softwarequellenliste aufgenommen werden. Weitere Informationen zum Hinzufügen von Node.js 14 oder 16 zur Softwarequelle finden Sie in der Dokumentation zur Softwarequelle.

Führen Sie nach dem Hinzufügen der Softwarequelle Folgendes aus:

sudo yum --disablerepo ol7_developer_epel-x86_64 install nodejs 
sudo yum install oci-typescript-sdk

Das Yum-Package oci-typescript-sdk funktioniert nur für Knotenversion 14 oder 16. Das Package oci-sdk wird im Ordner global node_modules installiert. Um das Package oci-sdk in einem Projekt zu verwenden, verknüpfen Sie das globale Package oci-sdk mit Ihrem lokalen Projekt.

Beispiel:

# Assuming you are in your project's top level directory
npm link oci-sdk
# You should now see oci-sdk package in your local project's node_modules folder

Da das Package oci-sdkglobal installiert ist, müssen Sie die Importanweisungen für die Unterpackages von oci-sdk aktualisieren, wenn Sie die oci-typescript-sdk-Beispiele auf GitHub ausführen. Beispiel:

import * as identity from "oci-identity"; // Change needed
import * as oci from "oci-sdk"; // No change needed

import * as identity from "oci-sdk/node_modules/oci-identity"; //Changed
import * as oci from "oci-sdk"; // No change

SDK für TypeScript und JavaScript mit NPM verwenden

NPM.

SDK konfigurieren

Die SDK-Services benötigen zwei Konfigurationstypen: Zugangsdaten und clientseitige HTTP-Einstellungen.

Zugangsdaten konfigurieren

Zuerst müssen Sie Ihre Zugangsdaten und die Konfigurationsdatei einrichten. Anweisungen hierzu finden Sie unter SDK- und CLI-Konfigurationsdatei.

Der Standardkonfigurationsspeicherort lautet "~/.oci/config", und das "DEFAULT"-Profil wird verwendet. Sie können ConfigFileAuthenticationDetailsProvider mit oder ohne Angabe des Konfigurationsspeicherorts und Profilnamens verwenden:

// TypeScript
import common = require("oci-common");
// Using default configuration
const provider: common.ConfigFileAuthenticationDetailsProvider = new common.ConfigFileAuthenticationDetailsProvider();
// Using personal configuration
const configurationFilePath = "~/your_config_location";
const configProfile = "your_profile_name";
const provider: common.ConfigFileAuthenticationDetailsProvider = new common.ConfigFileAuthenticationDetailsProvider(
  configurationFilePath,
  configProfile
);

// JavaScript
const common = require("oci-common");
// Using default configurations
const provider = new common.ConfigFileAuthenticationDetailsProvider();
// Using personal configuration
const configurationFilePath = "~/your_config_location";
const configProfile = "your_profile_name";
const provider = new common.ConfigFileAuthenticationDetailsProvider(
  configurationFilePath,
  configProfile
);

Benutzerdefinierte Optionen konfigurieren

In der Konfigurationsdatei können Sie benutzerdefinierte Schlüssel/Wert-Paare einfügen, die Sie definieren und dann nach Bedarf referenzieren. Beispiel: Sie können eine häufig verwendete Compartment-ID in der Konfigurationsdatei angeben:

[DEFAULT]
user=ocid1.user.oc1..<your_unique_id>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<your_unique_id>
customCompartmentId=ocid1.compartment.oc1..<your_unique_id>

Dann können Sie den Wert abrufen:

// TypeScript
import common = require("oci-common");
const configurationFilePath = "~/your_config_location";
const configProfile = "your_profile_name";
const config = common.ConfigFileReader.parseDefault(configurationFilePath);
const profile = config.accumulator.configurationsByProfile.get(configProfile);
customCompartmentId = profile.get("customCompartmentId") || "";


// JavaScript
import common = require("oci-common");
const configurationFilePath = "~/your_config_location";
const configProfile = "your_profile_name";
const config = common.ConfigFileReader.parseDefault(configurationFilePath);
const profile = config.accumulator.configurationsByProfile.get(configProfile);
customCompartmentId = profile.get("customCompartmentId") || "";