Tag: openapi
Die Open API-Spezifikation, ursprünglich bekannt als Fors-Spezifikation ist eine Spezifikation für maschinenlesbare interface-Dateien für die Beschreibung, Produktion, Konsum, und Visualisierung von RESTful-Web-services.
Wie man eine Eigenschaft definieren, können Sie string oder null-Wert in Open API (Fors)?
1 Antworten
Habe ich JSON-schema-Datei, wo Sie eine der Eigenschaften ist definiert als entweder string oder null: "type":["string", "null"] Bei der Konvertierung in YAML (für die Verwendung mit Open API/Swagger), wird es: type: - 'null' - string aber Fors-Editor
Open API: was schema zu akzeptieren (Komplex) JSON-Wert
2 Antworten
API, für die ich Schreibe, ein Stolzieren-2.0-Spezifikation ist im Grunde ein Shop für JSON-Wert. Ich soll einen Pfad, den Wert Lesen und einen Pfad zu speichern, JSON values (null, Zahl, integer, string, object, array) von nicht vordefinierten
So veröffentlichen Sie Dateien in Fors (Open API)?
3 Antworten
Ich bin mit Swagger zu dokumentieren, meine REST-services. Einer meiner Dienstleistungen erfordert eine CSV-Datei hochgeladen werden. Ich habe Folgendes in der parameters Abschnitt in meinem JSON-API-definition: { "name": "File", "description": "The file in zip format.", "paramType": "body",
Was ist Swagger und bezieht es sich auf OData?
1 Antworten
Ich bin vertraut mit den Microsoft-stack. Ich bin mit OData für einige meiner restful services. Vor kurzem stieß ich auf Swagger für die API-Dokumentation, und ich versuche zu verstehen, wie es bezieht sich auf OData. Beide von
Swagger Codegen (mit maven-plugin) für die Open API 3.0
2 Antworten
Will ich mit Swagger Codegen für Open API 3.0 YAML-Datei. Und ich sehe Swagger Codegen 3.0.0-rc0 verfügbar ist. Aber wenn ich versuche zu verwenden, dass ich laufen in Probleme. Im folgenden sind die details: Meine pom.xml Datei
Geben Sie ein array als parameter mit Swagger
1 Antworten
Wie kann ich angeben, wird ein array als parameter? Zum Beispiel, post /Personen gegeben werden kann, strings username, firstname und lastname, und array myArray. paths: /persons: post: parameters: - name: person_what_is_the_purpose_of_this in: body description: The person to
SwaggerUI/YAML - sollte NICHT über zusätzliche Eigenschaften additionalProperty: requestBody
2 Antworten
Entwurf einer API mithilfe - editor.stolzieren.io ich finde mich nicht in der Lage, fügen Sie eine requestBody Attribut, immer ein Fehler ich kann keine Adresse: Schema error at paths['/projects/{projectId}/user'].post should NOT have additional properties additionalProperty: requestBody Jump
Warum `additionalProperties` ist die Art und Weise zu repräsentieren Dictionary/Map in Fors/Open API 2.0
2 Antworten
Obwohl ich gesehen habe, die Beispiele in der Open API spec: type: object additionalProperties: $ref: '#/definitions/ComplexModel' es ist nicht offensichtlich für mich warum die Verwendung von additionalProperties ist das korrekte schema für eine Karte/Wörterbuch. Es hilft auch
"Diskriminator" Polymorphismus, Open API 2.0 (Swagger 2.0)
2 Antworten
Verweisen auf Open API 2.0, Schema-Objektoder Swagger 2.0, Schema-Objektund die definition von discriminator Feld: Fügt Unterstützung für Polymorphie. Der Diskriminator ist die schema-name der Eigenschaft, die verwendet wird, zu differenzieren zwischen anderen schema, dass die Erben dieses
Post json Körper mit swagger
1 Antworten
Ich möchte nach ein json-Körper mit Swagger, wie diese : curl -H "Content-Type: application/json" -X POST -d {"username":"foobar","password":"xxxxxxxxxxxxxxxxx", "email": "[email protected]"}' http://localhost/user/register Derzeit habe ich diese definition : "/auth/register": { "post": { "tags": [ "auth" ], "summary": "Create
Swagger / OpenAPI - Verwenden Sie $ ref, um einen wiederverwendbaren definierten Parameter zu übergeben
1 Antworten
Sagen wir, ich habe einen parameter wie limit. Diese bekommt man überall auf der Welt verwendet und es ist ein Schmerz, um es zu ändern, überall, wenn ich brauche, um Sie zu aktualisieren: parameters: - name: limit
Wie definieren sich gegenseitig ausschließende Abfrageparameter in Swagger (OpenAPI)?
4 Antworten
Habe ich eine Reihe von Parametern im Stolzieren wie dieser "parameters": [ { "name": "username", "description": "Fetch username by username/email", "required": false, "type": "string", "paramType": "query" }, { "name": "site", "description": "Fetch username by site", "required": false,
Wie beschreibt man diesen POST JSON-Anfragetext in OpenAPI (Swagger)?
2 Antworten
Habe ich eine POST-Anforderung verwendet die folgenden JSON-request-body. Wie kann ich beschreiben diese Anforderung Körper mit Hilfe der Open API (Fors)? { "testapi": { "testapiContext": { "messageId": "kkkk8", "messageDateTime": "2014-08-17T14:07:30+0530" }, "testapiBody": { "cameraServiceRq": { "osType": "android",