# Skripterstellung mit der REST-API und JavaScript

Schreib ein Skript mit dem Octokit.js-SDK, um mit der REST-API zu interagieren.

## Informationen zu Octokit.js

Wenn Sie ein Skript mit JavaScript für die Interaktion mit GitHubder REST-API schreiben möchten, empfiehlt es sich, GitHub das Octokit.js SDK zu verwenden. Octokit.js wird von GitHub gepflegt. Vom SDK werden bewährte Methoden implementiert, und es erleichtert dir, über JavaScript mit der REST-API zu interagieren. Octokit.js funktioniert mit allen modernen Browsern, Node.js und Deno. Weitere Informationen zu Octokit.js findest du in der [Octokit.js-Infodatei](https://github.com/octokit/octokit.js/#readme).

## Voraussetzungen

In diesem Handbuch wird davon ausgegangen, dass Sie mit JavaScript und der GitHub REST-API vertraut sind. Weitere Informationen zur REST-API findest du unter [Erste Schritte mit der REST-API](/de/enterprise-server@3.22/rest/using-the-rest-api/getting-started-with-the-rest-api).

Du musst `octokit` installieren und importieren, um die Octokit.js-Bibliothek nutzen zu können. In diesem Leitfaden werden Importanweisungen gemäß ES6 verwendet. Weitere Informationen zu verschiedenen Installations- und Importmethoden findest du im [Abschnitt „Verwendung“ der Octokit.js-Infodatei](https://github.com/octokit/octokit.js/#usage).

## Instanziieren und Authentifizieren

> \[!WARNING]
> Verwende die Anmeldeinformationen für die Authentifizierung wie ein Kennwort.
>
> Um Ihre Anmeldeinformationen zu schützen, können Sie Ihre Anmeldeinformationen als Geheimnis speichern und Ihr Skript über GitHub Actions ausführen. Weitere Informationen finden Sie unter [Verwenden von Geheimnissen in GitHub-Aktionen](/de/enterprise-server@3.22/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets).

> Wenn  sind, sollten Sie einen anderen CLI-Dienst verwenden, um Ihre Anmeldeinformationen sicher zu speichern.

### Authentifizieren mit einem personal access token

Wenn Sie die GitHub REST-API für den persönlichen Gebrauch nutzen möchten, können Sie ein personal access token erstellen. Weitere Informationen zum Erstellen eines personal access token finden Sie unter [Verwalten deiner persönlichen Zugriffstoken](/de/enterprise-server@3.22/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).

Importiere zunächst `Octokit` aus `octokit`. Übergeben Sie dann Ihr personal access token beim Erstellen einer Instanz von `Octokit`. Ersetzen Sie `YOUR-TOKEN` im folgenden Beispiel durch einen Verweis auf Ihre personal access token. Ersetzen Sie `HOSTNAME` durch den Namen von Ihre GitHub Enterprise Server-Instance.

```javascript copy
import { Octokit } from "octokit";

const octokit = new Octokit({ 
  baseUrl: "http(s)://HOSTNAME/api/v3",
  auth: 'YOUR-TOKEN',
});
```

### Authentifizieren mit einem GitHub App

Wenn Sie die API im Namen einer Organisation oder eines anderen Benutzers verwenden möchten, GitHub empfiehlt die Verwendung einer GitHub App. Wenn ein Endpunkt für GitHub Apps verfügbar ist, gibt die REST-Referenzdokumentation für diesen Endpunkt an, welcher Typ von GitHub App-Token erforderlich ist. Weitere Informationen findest du unter [Registrieren einer GitHub-App](/de/enterprise-server@3.22/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) und [Informationen zur Authentifizierung mit einer GitHub-App](/de/enterprise-server@3.22/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app).

Statt `Octokit` aus `octokit` zu importieren, importiere `App`. Ersetze `APP_ID` im folgenden Beispiel durch einen Verweis auf die ID deiner App. Ersetze `PRIVATE_KEY` durch einen Verweis auf den privaten Schlüssel deiner App. Ersetze `INSTALLATION_ID` durch die ID der Installation der App, für die du dich authentifizieren möchtest. Auf der Einstellungsseite für die App findest du die ID der App und kannst einen privaten Schlüssel generieren. Weitere Informationen finden Sie unter [Verwalten privater Schlüssel für GitHub Apps](/de/enterprise-server@3.22/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps). Eine Installations-ID kannst du mit den Endpunkten `GET /users/{username}/installation`, `GET /repos/{owner}/{repo}/installation` oder `GET /orgs/{org}/installation` abrufen. Weitere Informationen finden Sie unter [REST-API-Endpunkte für GitHub Apps](/de/enterprise-server@3.22/rest/apps/apps). Ersetzen Sie `HOSTNAME` durch den Namen von Ihre GitHub Enterprise Server-Instance.

```javascript copy
import { App } from "octokit";

const app = new App({
  appId: APP_ID,
  privateKey: PRIVATE_KEY,
  Octokit: Octokit.defaults({
    baseUrl: "http(s)://HOSTNAME/api/v3",
  }),
});

const octokit = await app.getInstallationOctokit(INSTALLATION_ID);
```

### Authentifizieren in GitHub Actions

Wenn Sie die API in einem GitHub Actions Workflow verwenden möchten, empfiehlt GitHub, sich bei der integrierten `GITHUB_TOKEN` zu authentifizieren, anstatt ein Token zu erstellen. Sie können dem `GITHUB_TOKEN` mit dem Schlüssel `permissions` Berechtigungen erteilen. Weitere Informationen zu `GITHUB_TOKEN` findest du unter [GITHUB\_TOKEN](/de/enterprise-server@3.22/actions/concepts/security/github_token).

Wenn in deinem Workflow auf Ressourcen außerhalb des Repositorys des Workflows zugegriffen werden muss, kannst du `GITHUB_TOKEN` nicht verwenden. Speichere die Anmeldeinformationen in diesem Fall als Geheimnis und ersetze `GITHUB_TOKEN` in den folgenden Beispielen durch den Namen des Geheimnisses. Weitere Informationen zu Geheimnissen findest du unter [Verwenden von Geheimnissen in GitHub-Aktionen](/de/enterprise-server@3.22/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets).

Wenn Sie das `run` Schlüsselwort verwenden, um Ihr JavaScript-Skript in Ihren GitHub Actions Workflows auszuführen, können Sie den Wert `GITHUB_TOKEN` als Umgebungsvariable speichern. Vom Skript kann als `process.env.VARIABLE_NAME` auf die Umgebungsvariable zugegriffen werden.

Beispiel: In diesem Workflowschritt wird `GITHUB_TOKEN` in einer Umgebungsvariable mit der Bezeichnung `TOKEN` gespeichert:

```yaml
- name: Run script
  env:
    TOKEN: ${{ secrets.GITHUB_TOKEN }}
  run: |
    node .github/actions-scripts/use-the-api.mjs
```

Vom Skript, das vom Workflow ausgeführt wird, wird `process.env.TOKEN` zur Authentifizierung verwendet:

```javascript copy
import { Octokit } from "octokit";

const octokit = new Octokit({ 
  baseUrl: "http(s)://HOSTNAME/api/v3",
  auth: process.env.TOKEN,
});
```

### Instanziieren ohne Authentifizierung

Du kannst die REST-API ohne Authentifizierung verwenden, obwohl du dann eine niedrigere Ratenbegrenzung hast und einige Endpunkte nicht verwenden kannst. Um eine Instanz von `Octokit` ohne Authentifizierung zu erstellen, übergeben Sie das `auth`-Argument nicht. Legen Sie die Basis-URL auf `http(s)://HOSTNAME/api/v3`. Ersetzen Sie `[hostname]` durch den Namen von Ihre GitHub Enterprise Server-Instance.

```javascript copy
import { Octokit } from "octokit";

const octokit = new Octokit({ 
  baseUrl: "http(s)://HOSTNAME/api/v3",
);
```

## Anfragen stellen

Octokit unterstützt mehrere Möglichkeiten, Anforderungen auszuführen. Du kannst die `request`-Methode verwenden, um Anforderungen auszuführen, wenn du HTTP-Verb und -Pfad für den Endpunkt kennst. Du kannst die `rest`-Methode verwenden, wenn du die Vorteile der automatischen Vervollständigung in der IDE und bei der Eingabe nutzen möchtest. Für paginierte Endpunkte kannst du die `paginate`-Methode verwenden, um mehrere Datenseiten anzufordern.

### Verwenden der `request`-Methode für das Ausführen von Anfragen

Um Anforderungen mit der `request`-Methode auszuführen, übergib die HTTP-Methode und den Pfad als erstes Argument. Gib alle Text-, Abfrage- oder Pfadparameter als zweites Argument in einem Objekt an. Beispiel: Zum Ausführen einer `GET`-Anforderung an `/repos/{owner}/{repo}/issues` und Übergeben der Parameter `owner`, `repo` und `per_page`:

```javascript copy
await octokit.request("GET /repos/{owner}/{repo}/issues", {
  owner: "github",
  repo: "docs",
  per_page: 2
});
```

Bei der `request`-Methode wird der Header `Accept: application/vnd.github+json` automatisch übergeben. Füge zum Übergeben zusätzlicher Header oder eines anderen `Accept`-Headers dem Objekt eine `headers`-Eigenschaft hinzu, die als zweites Argument übergeben wird. Der Wert der Eigenschaft `headers` ist ein Objekt mit den Headernamen als Schlüssel und den Headerwerten als Werte. Beispiel: Senden eines `content-type`-Headers mit dem Wert `text/plain` und eines `x-github-api-version`-Headers mit dem Wert `2026-03-10`:

```javascript copy
await octokit.request("POST /markdown/raw", {
  text: "Hello **world**",
  headers: {
    "content-type": "text/plain",
    "x-github-api-version": "2026-03-10",
  },
});
```

### Verwendung von `rest`-Endpunktmethoden zum Ausführen von Anfragen

Jeder REST-API-Endpunkt verfügt über eine zugeordnete `rest`-Endpunktmethode in Octokit. Diese Methoden werden in der Regel in Ihrer IDE zur bequemen Nutzung automatisch vervollständigt. Du kannst beliebige Parameter als Objekt an die Methode übergeben.

```javascript copy
await octokit.rest.issues.listForRepo({
  owner: "github",
  repo: "docs",
  per_page: 2
});
```

Wenn du eine typisierte Sprache wie TypeScript verwendest, kannst du außerdem Typen für die Verwendung mit diesen Methoden importieren. Weitere Informationen findest du [im Abschnitt „TypeScript“ der plugin-rest-endpoint-methods.js-Infodatei](https://github.com/octokit/plugin-rest-endpoint-methods.js/#typescript).

### Erstellen paginierter Anfragen

Wenn der Endpunkt paginiert ist und du mehr als eine Seite mit Ergebnissen abrufen möchtest, kannst du die `paginate`-Methode verwenden.
`paginate` ruft die nächste Ergebnisseite ab, bis die letzte Seite erreicht ist, und gibt dann alle Ergebnisse als einzelnes Array zurück. Einige Endpunkte geben paginierte Ergebnisse als Array in einem Objekt zurück, anstatt die paginierten Ergebnisse als Array zurückzugeben.
`paginate` gibt immer ein Array aus Elementen zurück, auch wenn das Rohergebnis ein Objekt war.

So werden im folgenden Beispiel alle Issues aus dem Repository `github/docs` abgerufen. Obwohl 100 Issues gleichzeitig angefordert werden, wird die Funktion erst zurückgegeben, wenn die letzte Datenseite erreicht ist.

```javascript copy
const issueData = await octokit.paginate("GET /repos/{owner}/{repo}/issues", {
  owner: "github",
  repo: "docs",
  per_page: 100,
  headers: {
    "x-github-api-version": "2026-03-10",
  },
});
```

Die `paginate`-Methode akzeptiert eine optionale Zuordnungsfunktion, die du verwenden kannst, um ausschließlich die Daten zu sammeln, die du aus der Antwort erhalten möchtest. Dadurch wird die Arbeitsspeicherauslastung des Skripts reduziert. In der Map-Funktion kann ein zweites Argument (`done`) verwendet werden, das du aufrufen kannst, um die Paginierung zu beenden, bevor die letzte Seite erreicht ist. Dadurch kannst du eine Teilmenge der Seiten abrufen. Im folgenden Beispiel werden beispielsweise weiterhin Ergebnisse abgerufen, bis ein Issue zurückgegeben wird, das im Titel „test“ enthält. Für die zurückgegebenen Datenseiten werden nur der Titel und der Autor des Issue gespeichert.

```javascript copy
const issueData = await octokit.paginate("GET /repos/{owner}/{repo}/issues", {
  owner: "github",
  repo: "docs",
  per_page: 100,
  headers: {
    "x-github-api-version": "2026-03-10",
  },
},
    (response, done) => response.data.map((issue) => {
    if (issue.title.includes("test")) {
      done()
    }
    return ({title: issue.title, author: issue.user.login})
  })
);
```

Anstatt alle Ergebnisse gleichzeitig abzurufen, kannst du `octokit.paginate.iterator()` verwenden, um jeweils eine einzelne Seite zu durchlaufen. So wird im folgenden Beispiel jeweils eine Seite mit Ergebnissen abgerufen und es wird jedes Objekt von der Seite verarbeitet, bevor die nächste Seite abgerufen wird. Sobald ein Issue erreicht ist, das im Titel „Test“ enthält, beendet das Skript die Iteration und gibt Titel und Autor des Issues für jedes verarbeitete Objekt zurück. Der Iterator ist die speichereffizienteste Methode zum Abrufen paginierter Daten.

```javascript copy
const iterator = octokit.paginate.iterator("GET /repos/{owner}/{repo}/issues", {
  owner: "github",
  repo: "docs",
  per_page: 100,
  headers: {
    "x-github-api-version": "2026-03-10",
  },
});

let issueData = []
let breakLoop = false
for await (const {data} of iterator) {
  if (breakLoop) break
  for (const issue of data) {
    if (issue.title.includes("test")) {
      breakLoop = true
      break
    } else {
      issueData = [...issueData, {title: issue.title, author: issue.user.login}];
    }
  }
}
```

Du kannst die `paginate`-Methode auch mit den `rest`-Endpunktmethoden verwenden. Übergib die `rest`-Endpunktmethode als erstes Argument. Übergib alle Parameter als zweites Argument.

```javascript copy
const iterator = octokit.paginate.iterator(octokit.rest.issues.listForRepo, {
  owner: "github",
  repo: "docs",
  per_page: 100,
  headers: {
    "x-github-api-version": "2026-03-10",
  },
});
```

Weitere Informationen zur Paginierung findest du unter [Verwenden der Paginierung in der REST-API](/de/enterprise-server@3.22/rest/using-the-rest-api/using-pagination-in-the-rest-api).

## Abfangen von Fehlern

### Erfassung aller Fehler

Manchmal gibt die GitHub REST-API einen Fehler zurück. Beispielsweise erhältst du eine Fehlermeldung, wenn das Zugriffstoken abgelaufen ist oder wenn du einen erforderlichen Parameter ausgelassen hast. Von Octokit.js wird die Anforderung automatisch wiederholt, wenn ein anderer Fehler als `400 Bad Request`, `401 Unauthorized`, `403 Forbidden`, `404 Not Found`und `422 Unprocessable Entity` angezeigt wird. Wenn sogar nach wiederholten Versuchen ein API-Fehler auftritt, wird von Octokit.js eine Fehlermeldung ausgegeben, die den HTTP-Statuscode der Antwort (`response.status`) und die Antwortheader (`response.headers`) enthält. Du musst diese Fehler im Code behandeln. Du kannst beispielsweise einen try/catch-Block verwenden, um Fehler abzufangen:

```javascript copy
let filesChanged = []

try {
  const iterator = octokit.paginate.iterator("GET /repos/{owner}/{repo}/pulls/{pull_number}/files", {
    owner: "github",
    repo: "docs",
    pull_number: 22809,
    per_page: 100,
    headers: {
      "x-github-api-version": "2026-03-10",
    },
  });

  for await (const {data} of iterator) {
    filesChanged = [...filesChanged, ...data.map(fileData => fileData.filename)];
  }
} catch (error) {
  if (error.response) {
    console.error(`Error! Status: ${error.response.status}. Message: ${error.response.data.message}`)
  }
  console.error(error)
}
```

### Handhabung von beabsichtigten Fehlercodes

Manchmal verwendet GitHub einen 4xx-Statuscode, um eine Antwort anzugeben, die keinen Fehler darstellt. Wenn der von dir verwendete Endpunkt dies tut, kannst du zusätzliche Behandlung für bestimmte Fehler hinzufügen. Beispielsweise wird vom Endpunkt `GET /user/starred/{owner}/{repo}` der Statuscode `404` zurückgegeben, wenn das Repository nicht mit einem Stern versehen ist. Im folgenden Beispiel wird die Antwort `404` verwendet, um anzugeben, dass das Repository nicht mit einem Stern versehen wurde. Alle anderen Fehlercodes werden als Fehler behandelt.

```javascript copy
try {
  await octokit.request("GET /user/starred/{owner}/{repo}", {
    owner: "github",
    repo: "docs",
    headers: {
      "x-github-api-version": "2026-03-10",
    },
  });

  console.log(`The repository is starred by me`);

} catch (error) {
  if (error.status === 404) {
    console.log(`The repository is not starred by me`);
  } else {
    console.error(`An error occurred while checking if the repository is starred: ${error?.response?.data?.message}`);
  }
}
```

### Behandeln von Fehlern bei der Ratenbegrenzung

Wenn ein Ratenlimitfehler angezeigt wird, solltest du die Anforderung nach einer Wartezeit wiederholen. Wenn Sie von einer Ratenbegrenzung betroffen sind, gibt GitHub einen `403 Forbidden`-Fehler zurück, und der Wert des Antwortheaders `x-ratelimit-remaining` ist `"0"`. Die Antwortheader enthalten einen `x-ratelimit-reset`-Header, in dem der Zeitpunkt (in UTC-Epochensekunden) angegeben ist, zu dem das aktuelle Ratenlimitfenster zurückgesetzt wird. Du kannst die Anfrage nach der Zeit, die von `x-ratelimit-reset` angegeben wird, erneut versuchen.

```javascript copy
async function requestRetry(route, parameters) {
  try {
    const response = await octokit.request(route, parameters);
    return response
  } catch (error) {
    if (error.response && error.status === 403 && error.response.headers['x-ratelimit-remaining'] === '0') {
      const resetTimeEpochSeconds = error.response.headers['x-ratelimit-reset'];
      const currentTimeEpochSeconds = Math.floor(Date.now() / 1000);
      const secondsToWait = resetTimeEpochSeconds - currentTimeEpochSeconds;
      console.log(`You have exceeded your rate limit. Retrying in ${secondsToWait} seconds.`);
      setTimeout(requestRetry, secondsToWait * 1000, route, parameters);
    } else {
      console.error(error);
    }
  }
}

const response = await requestRetry("GET /repos/{owner}/{repo}/issues", {
    owner: "github",
    repo: "docs",
    per_page: 2
  })
```

## Verwendung der Antwort

Bei der Methode `request` wird eine Zusage zurückgegeben, die in ein Objekt aufgelöst wird, wenn die Anforderung erfolgreich war. Die Objekteigenschaften sind `data` (der vom Endpunkt zurückgegebene Antworttext), `status` (der HTTP-Antwortcode), `url` (die URL der Anforderung) und `headers` (ein Objekt, das die Antwortheader enthält). Sofern nicht anders angegeben, verwendet der Antworttext das JSON-Format. Von einigen Endpunkten wird kein Antworttext zurückgegeben. In diesen Fällen wird die Eigenschaft `data` weggelassen.

```javascript copy
const response = await octokit.request("GET /repos/{owner}/{repo}/issues/{issue_number}", {
  owner: "github",
  repo: "docs",
  issue_number: 11901,
  headers: {
    "x-github-api-version": "2026-03-10",
  },
});

console.log(`The status of the response is: ${response.status}`)
console.log(`The request URL was: ${response.url}`)
console.log(`The x-ratelimit-remaining response header is: ${response.headers["x-ratelimit-remaining"]}`)
console.log(`The issue title is: ${response.data.title}`)
```

Auf ähnliche Weise wird bei der Methode `paginate` eine Zusage zurückgegeben. Wenn die Anforderung erfolgreich war, wird die Zusage in ein Array von Daten aufgelöst, die vom Endpunkt zurückgegeben werden. Anders als bei der Methode `request` werden bei der Methode `paginate` Statuscode, URL oder Header nicht zurückgegeben.

```javascript copy
const data = await octokit.paginate("GET /repos/{owner}/{repo}/issues", {
  owner: "github",
  repo: "docs",
  per_page: 100,
  headers: {
    "x-github-api-version": "2026-03-10",
  },
});

console.log(`${data.length} issues were returned`)
console.log(`The title of the first issue is: ${data[0].title}`)
```

## Beispielskript

Hier siehst du ein vollständiges Beispielskript, in dem Octokit.js verwendet wird. Durch das Skript wird `Octokit` importiert, und es wird eine neue Instanz von `Octokit` erstellt. Wenn Sie sich statt mit einer GitHub App mit einer personal access token authentifizieren möchten, würden Sie `App` anstelle von `Octokit` importieren und instanziieren. Weitere Informationen finden Sie unter [Authenticating with a GitHub App](#authenticating-with-a-github-app).

Durch die Funktion `getChangedFiles` werden alle Dateien abgerufen, die für einen Pull Request geändert wurden. Durch die Funktion `commentIfDataFilesChanged` wird die Funktion `getChangedFiles` aufgerufen. Wenn eine der Dateien, die vom Pull Request geändert wurden, `/data/` im Dateipfad enthält, wird der Pull Request von der Funktion kommentiert.

```javascript copy
import { Octokit } from "octokit";

const octokit = new Octokit({ 
  baseUrl: "http(s)://HOSTNAME/api/v3",
  auth: 'YOUR-TOKEN',
});

async function getChangedFiles({owner, repo, pullNumber}) {
  let filesChanged = []

  try {
    const iterator = octokit.paginate.iterator("GET /repos/{owner}/{repo}/pulls/{pull_number}/files", {
      owner: owner,
      repo: repo,
      pull_number: pullNumber,
      per_page: 100,
      headers: {
        "x-github-api-version": "2026-03-10",
      },
    });

    for await (const {data} of iterator) {
      filesChanged = [...filesChanged, ...data.map(fileData => fileData.filename)];
    }
  } catch (error) {
    if (error.response) {
      console.error(`Error! Status: ${error.response.status}. Message: ${error.response.data.message}`)
    }
    console.error(error)
  }

  return filesChanged
}

async function commentIfDataFilesChanged({owner, repo, pullNumber}) {
  const changedFiles = await getChangedFiles({owner, repo, pullNumber});

  const filePathRegex = new RegExp(/\/data\//, "i");
  if (!changedFiles.some(fileName => filePathRegex.test(fileName))) {
    return;
  }

  try {
    const {data: comment} = await octokit.request("POST /repos/{owner}/{repo}/issues/{issue_number}/comments", {
      owner: owner,
      repo: repo,
      issue_number: pullNumber,
      body: `It looks like you changed a data file. These files are auto-generated. \n\nYou must revert any changes to data files before your pull request will be reviewed.`,
      headers: {
        "x-github-api-version": "2026-03-10",
      },
    });

    return comment.html_url;
  } catch (error) {
    if (error.response) {
      console.error(`Error! Status: ${error.response.status}. Message: ${error.response.data.message}`)
    }
    console.error(error)
  }
}

await commentIfDataFilesChanged({owner: "github", repo: "docs", pullNumber: 191});
```

## Nächste Schritte

* Weitere Informationen zu Octokit.js findest du in der [Dokumentation zu Octokit.js](https://github.com/octokit/octokit.js/#readme).
* Sehen Sie sich einige Beispiele für das reale Leben an, wie GitHub Docs Octokit.js verwendet, indem [Sie das GitHub Docs-Repository durchsuchen](https://github.com/search?q=repo%3Agithub%2Fdocs%20path%3A.github%20octokit\&type=code).