OpenAPITools / OpenAPITools/openapi-generator-cli

[Idea] Provide API Interface

Offen
#689 0 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
TypeScript
Sterne
2k
Forks
208
Ø Merge
7 Std. 12 Min.
Gemergte PRs (30 T.)
6

Beschreibung

What do you about the idea to have an API interface in addition to CLI?

A bit of context, we're currently using openapi-generator-cli for our internal tools and call it as a child process, it would be more practical to have it as a function or class with params listed in TypeScript

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Das Issue nennt keine Dateien oder Tests; beginne damit, den vorhandenen CLI-Einstiegspunkt des Pakets zu finden und zu prüfen, wie er openapi-generator aufruft. Lege vor der Implementierung die öffentliche TypeScript-Funktion oder -Klasse, ihre Parameter und das erwartete Verhalten fest und dokumentiere anschließend Tests, die zeigen, dass die API funktioniert, ohne den CLI-Prozess zu starten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
openapi, typescript
Bereich
api, cli
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.