OpenAPI-Spec hochladen und aktualisieren
Eine Simulation liefert deine eigene API aus ihrer OpenAPI-Spec aus. YAML und JSON funktionieren beide, OpenAPI 3.0 und 3.1. Swagger 2.0 wird nicht unterstützt; wandle es zuerst in OpenAPI 3 um. Specs mit zirkulären Referenzen sind in Ordnung: Die Generierung erkennt den Zyklus und geht damit um.
Spec hochladen
Öffne in der Simulation Endpunkte, klicke Hinzufügen und wähle OpenAPI-Spec. Lege die Datei ab oder wähle sie aus, dann bestimme den Mount-Pfad; der Dialog zeigt die URL, unter der deine Spec antworten wird.
Klicke Spec hinzufügen und deploye dann, um sie live zu nehmen.
Das Größenlimit
Eine Spec-Datei darf bis zu 4 MB groß sein. Das ist ein weiches Limit: Ist deine Spec größer, teile sie in mehrere Specs auf oder kontaktiere uns und wir heben es für deine Organisation an.
Codegen-Simulationen haben kein Upload-Limit, weil es keinen Upload gibt: Der Code wird aus deiner Spec in deinem Repository generiert, und die Spec selbst erreicht uns nie.
Siehe Codegen-Simulationen.
Große Specs
Eine große Spec ist schwerer auszuliefern: Sie braucht mehr Speicher und startet langsamer als eine kleine.
Zwei Optionen pro Service helfen, unter Service-Konfiguration im Tab Spec-Optionen:
- Operationen lazy laden parst jede Operation erst bei ihrer ersten Anfrage statt alle beim Start. Das beschleunigt den Start bei großen Specs.
- Schema vereinfachen kürzt überdimensionierte Schemas (überzählige anyOf/oneOf/allOf-Zweige), damit sehr große Specs handhabbar bleiben.
Spec später ersetzen
Deine API ändert sich; der Mock zieht nach, indem du die Datei ersetzt. Wähle in der Service-Konfiguration den Service, öffne das Menü in der Ecke und wähle Datei ersetzen. Der Mount-Pfad bleibt, und die Endpunkt-Auswahl bleibt erhalten, wo die Pfade übereinstimmen; was du abgeschaltet hast, bleibt abgeschaltet.
Deploye erneut, um die neue Version auszuliefern.