Einführung in die Definition der Verwendung von API-Schlüsseln in der OpenAPI-Spezifikation

API-Schlüssel definieren

Ossi Galkin avatarGeschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contents

Definieren der Verwendung des API-Schlüssels in der OpenAPI-Spezifikation

Um API-Schlüssel zur Authentifizierung verwenden zu können, müssen Sie zunächst in der OpenAPI-Spezifikation der API definieren, dass die API-Schlüssel-Authentifizierung verwendet werden soll.

Die Verwendung von API-Schlüsseln ist in den OpenAPI-Spezifikationen mit dem Security Scheme Object definiert (Sicherheitsschemata).

Beispiel:

Komponenten: Sicherheitsschemata: ApiKeyAuth: Typ: API-Schlüssel Name: x-API-Schlüssel in: Header

Dies ist eine sehr typische Methode zum Einrichten der API-Schlüsselauthentifizierung. Bei dieser Konfiguration lautet der Name des API-Schlüssels x-api-key und muss vom API-Client in den HTTP-Headern gesendet werden.

Einzelheiten zu den API-Schlüsselkonfigurationsoptionen und weitere Beispiele finden Sie imSicherheitsschemata - Objektdokumentation.

Definieren, bei welchen API-Operationen der konfigurierte API-Schlüssel verwendet wird

Zusätzlich zur Definition des Sicherheitsschemaobjekts für die API-Schlüsselauthentifizierung müssen Sie auch angeben, auf welche API-Operationen das definierte Sicherheitsschema angewendet werden soll.

In diesem Beispiel haben wir das Sicherheitsanforderungsobjekt (Sicherheit)-Objekt nach dem Komponentenobjekt und definierte das ApiKeyAuth-Sicherheitsschema, das auf alle in dieser OpenAPI-Spezifikation definierten API-Operationen angewendet werden soll.

Das hinzugefügte Sicherheitsanforderungsobjekt (Sicherheit) ist fett markiert:

Komponenten: Sicherheitsschemata: ApiKeyAuth: Typ: API-Schlüssel Name: x-API-Schlüssel in: Header-Sicherheit: - ApiKeyAuth: [ ]


Weitere Informationen und Beispiele finden Sie imDokumentation zum Sicherheitsanforderungsobjekt.

Vollständiges OpenAPI-Beispiel einer einfachen API mit global für alle API-Vorgänge konfigurierter API-Schlüsselauthentifizierung

openapi: 3.0.1 Info: Titel: Wetter-API Beschreibung: API zur Bereitstellung von Wetterinformationen Version: 1.0.0 Server: - URL: /api/weather/v1 Pfade: /weathernow: get: Parameter: - Name: Stadt in: Abfragebeschreibung: Stadt, für die Sie Wetterinformationen abrufen möchten. Erforderlich: True Schema: Typ: Zeichenfolge Antworten: „200“: Beschreibung: OK Inhalt: Anwendung/Text: Schema: Typ: Zeichenfolge Komponenten: Sicherheitsschemata: ApiKeyAuth: Typ: API-Schlüssel Name: x-API-Schlüssel in: Header-Sicherheit: - ApiKeyAuth: [ ]

Der nächste Artikel istBeispiel für ein typisches API-Anwendungsszenario


Verwandte ArtikelAPI-SchlüsselEinführung in OpenAPI 2.0 und OpenAPI 3.0Einführung in API-SchlüsselEinführung in die Weitergabe eines API-Schlüssels an die Frends API von einem ClientEinführung in die Definition der Verwendung von OAuth 2.0 in der OpenAPI-Spezifikation