技能 generate-api-client
🔄

generate-api-client

安全 🌐 網路存取📁 檔案系統存取⚙️ 外部命令

Typsichere API-Clients aus OpenAPI generieren

Entwickler verbringen Stunden damit, manuell API-Client-Code und Typen zu erstellen. Diese Automatisierung generiert API-Clients aus OpenAPI-Spezifikationen mit Orval. Sie validiert die Spezifikation, führt Orval aus, um TypeScript-Client-Code zu generieren, überprüft die Ausgabe und bestätigt die Typkorrektheit.

支援: Claude Codex Code(CC)
📊 70 充足
1

下載技能 ZIP

2

在 Claude 中上傳

前往 設定 → 功能 → 技能 → 上傳技能

3

開啟並開始使用

測試它

正在使用「generate-api-client」。 Generate API client from OpenAPI specification

預期結果:

  • OpenAPI specification found at backend/src/main/resources/static/api-docs.yaml
  • Orval generation completed successfully
  • Generated files verified in frontend/src/lib/api/generated/
  • TypeScript type checking passed
  • Next steps: Import generated API client using import { ApiClient } from '@/lib/api/generated/api'

正在使用「generate-api-client」。 Update the existing API client after backend API specification was modified

預期結果:

  • Found modified api-docs.yaml with 3 new endpoints
  • Running Orval to regenerate API client...
  • Generated 5 new TypeScript interfaces
  • Updated API client with new endpoints and types
  • TypeScript compilation successful - no errors

安全審計

安全
v5 • 1/16/2026

Pure documentation-based skill containing only workflow instructions for Orval API client generation. All 16 static findings are FALSE POSITIVEs: the 'hardcoded URL' is metadata, 'filesystem access' is a URL field, 'weak cryptographic algorithm' patterns are Japanese/English description text, and 'shell backtick execution' patterns are markdown code block syntax (NOT Ruby/shell execution). No executable code, network calls, or file system operations exist in this skill.

2
已掃描檔案
231
分析行數
3
發現項
5
審計總數
審計者: claude 查看審計歷史 →

品質評分

38
架構
100
可維護性
85
內容
30
社群
100
安全
83
規範符合性

你能建構什麼

API mit Frontend synchronisieren

API-Client automatisch aktualisieren, wenn sich die Backend-API-Spezifikation ändert

Client-Bibliotheken generieren

Typsicheren Client-Code aus OpenAPI-Spezifikationen ohne manuelles Tippen erstellen

API-Verträge standardisieren

Sicherstellen, dass Frontend und Backend durch automatisierte Client-Generierung synchron bleiben

試試這些提示

API-Client generieren
API-Client aus OpenAPI-Spezifikation generieren
Bestehenden Client aktualisieren
Den bestehenden API-Client aktualisieren, nachdem die Backend-API-Spezifikation geändert wurde
Generierung überprüfen
Die generierten API-Client-Dateien überprüfen und TypeScript-Typprüfung ausführen
Vollständiger Generierungs-Workflow
Den vollständigen API-Client-Generierungs-Workflow ausführen: Spezifikation prüfen, Client generieren, Dateien überprüfen und Typprüfung ausführen

最佳實務

  • Halten Sie api-docs.yaml mit der tatsächlichen Backend-API-Implementierung synchron
  • Führen Sie die API-Client-Generierung nach allen Backend-API-Änderungen vor dem Commit aus
  • Fügen Sie generierte Client-Dateien der Versionskontrolle hinzu für Team-Konsistenz

避免

  • Manuelles Bearbeiten generierter API-Client-Dateien anstatt die Spezifikation zu aktualisieren
  • Überspringen der TypeScript-Typprüfung nach der Generierung
  • Verwenden veralteter OpenAPI-Spezifikationen für die Client-Generierung

常見問題

Welche Tools sind mit dieser Fähigkeit kompatibel?
Funktioniert mit Claude, Codex und Claude Code. Generiert TypeScript-Clients für jedes Frontend-Framework.
Welche Grenzen gibt es bei der OpenAPI-Spezifikationsgröße?
Orval verarbeitet große Spezifikationen. Sehr große Spezifikationen können länger dauern und die Bundle-Größe erhöhen.
Wie integriere ich dies in meinen Build-Prozess?
Fügen Sie den Generierungsbefehl zu Ihren package.json-Skripts hinzu. Führen Sie ihn vor der Entwicklung oder in der CI-Pipeline aus.
Sind meine Daten während der Generierung sicher?
Ja. Orval läuft lokal und liest nur die OpenAPI-Spezifikationsdatei. Es werden keine Daten an externe Server gesendet.
Generierung fehlgeschlagen mit Typfehlern. Was sollte ich tun?
Stellen Sie sicher, dass Ihre OpenAPI-Spezifikation gültig ist. Stellen Sie sicher, dass Backend- und Frontend-TypeScript-Konfigurationen kompatibel sind.
Wie unterscheidet sich dies von Swagger Codegen?
Orval generiert speziell für TypeScript und React mit besserer Typ-Inferenz und Hooks-Unterstützung.

開發者詳情

檔案結構

📄 SKILL.md