Tag: swagger-2.0
Swagger ist eine Spezifikation und framework-Implementierung für die Beschreibung, Produktion, Konsum, und Visualisierung von RESTful-web-services. Swagger 2.0 ist die aktuelle generation des spec und enthält viele Verbesserungen gegenüber 1.X.
Diese Angabe wird jetzt als Open-API 2.0.
@ApiResponses und @ApiResponses in Fors
1 Antworten
Habe ich kommentiert meine Methode wie, @ApiOperation( value = "Get time spent on category", response = CategoryBean.class, responseContainer = "List", notes = "API to get the time spent on all tasks based on category" ) @ApiImplicitParams( {
Erstellen von komplexen Typen (Definitionen) im Fors
1 Antworten
Erstellte ich eine definition genannt Product genannt Text (siehe code). Auf parameters von paths ich kann nicht mit dem Typ Text erstellt in Definitionen. Auf die definition Product ich haben eine Eigenschaft namens message und ich will,
Eine deterministische version der JSON-schema-Objekt
1 Antworten
Ich versuche, mit der Swagger-Editor erstellen Sie eine benutzerdefinierte JSON/YAML für meine API. Grundsätzlich möchte ich beschreiben, eine POST-Anforderung an einen Endpunkt mit Accept und Content-Type - Header und POST-Daten in form von JSON wie in der
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
Customizing-Request-Header Beschreibung in Swagger-UI mit Springfox-Swagger2
3 Antworten
Ich bin mit Springfox Swagger2 version 2.4.0, Springfox Swagger-UI-version 2.4.0 und Swagger Anmerkungen version 1.5.0 in meinem Spring-Boot-Anwendung. Die Frage hier ist, ich bin in der Lage zu generieren swagger-UI für meine controller-API-und ich bin in der
Wie zu brechen Fors 2.0 JSON-Datei in mehrere Module
7 Antworten
Ich bin versucht zu brechen, meine API-Dokument, das in mehrere JSON-Dateien können unabhängig bearbeitet werden. Alle Beispiele habe ich in der Lage zu finden, verwenden Sie das Swagger 1.2 schema der hat eine "api":{} Objekt für es
Swashbuckle-Arroganz - Wie kommentieren von content-Typen?
4 Antworten
Wie kann ich mein kommentieren ASP.NET WebAPI Aktionen, so dass die swagger Metadaten umfasst die content-Typen, die meine Ressourcen unterstützen? Speziell, ich will die Dokumentation zeigen, dass eine meiner Ressourcen können wieder die 'ursprünglichen' application/json und application/xml
Swagger; geben Sie zwei Antworten mit dem gleichen code basiert auf optionale parameter
2 Antworten
Diese Frage ist nicht duplizieren ( Swagger - Geben Sie Optional Objekt-Eigenschaft oder Mehrere Antworten ), weil, die OP wurde versucht, wieder ein 200 oder 400. Ich habe eine GET mit einem optionalen parameter; z.B. GET /endpoint?selector=foo.
Definition von enum-array in Swagger 2.0
2 Antworten
type": "array", "items": { "type": "string", "enum": ["MALE","FEMALE","WORKER"] } oder type": "array", "items": { "type": "string", }, "enum": ["MALE","FEMALE","WORKER"] ? Nichts in der spec zu diesem. Das Ziel ist natürlich um swagger-ui zu zeigen, die enum-Werte. Beide
Warum Fehler in der Winkel-5 : hat keine exportiert Mitglied "OpaqueToken'.?
5 Antworten
Habe ich eine Eckige 4-Anwendung, die ich bin, das Upgrade auf Winkel 5. Ich erhalte die folgende Fehlermeldung. FEHLER in src/app/Anwendung/services//erzeugt Variablen.ts(1,10): Fehler TS2305: Modul '"..../node_modules/@eckig/core/core"' hat nicht exportiert Mitglied "OpaqueToken'. Code-snippet : import { OpaqueToken }
Wie Sie angeben, dass eine pdf-Datei zurückgegeben, stolzieren?
1 Antworten
Ich habe einen Anruf bekommen in meinem swagger REST-API zurückgeben muss, eine pdf-Datei. Es gibt keine klare Beispiel /eine Dokumentation, wie dies zu tun, ohne dass ein syntax-Fehler. responses: 200: description: Returns PDF schema: [application/pdf] und responses:
Geben Sie ein array von strings als parameter body in swagger-API
4 Antworten
Ich würde gerne post ein array von strings, wie [ "id1", "id2" ] einem Swagger-basierte API. In meinem swagger-Datei habe ich diese Zeilen: paths: /some_url: post: parameters: - name: ids in: body required: true Was ist der
Wie definieren Swagger 2.0 JSON zu füllen Standard-Körper-parameter-Objekt in Swagger-UI?
2 Antworten
Unserer aktuellen Bereitstellung von mustern verlangen, mich manuell zu schreiben, meine swagger json-Ausgabe, die verbraucht wird, durch die Swagger-basierte Benutzeroberfläche im Einsatz in meinem Unternehmen. Ich würde gerne die json-ich Schreibe zu bieten "default" - Werte zum
CORS-Problem auf Swagger-UI
5 Antworten
Kann mir jemand sagen, warum bekomme ich diese Fehler. GET http://127.0.0.1:9000/api-docs/service.json 200 OK 4ms swagger-ui.js (line 30261) Unable to Load SwaggerUI /api-docs/(line 83) Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at http://127.0.0.1:9000/api-
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
Konfigurieren von Swagger UI mit Spring Boot
4 Antworten
Ich versuche zu konfigurieren Swagger UI mit meinem Spring-boot-Anwendung. Obwohl die v2/api-docs zu sein scheint ordnungsgemäß geladen, die http://localhost:8080/swagger-ui.html wird nicht geladen, meine Anmerkungen REST-API. Hier ist was ich habe: pom.xml: ... <!--Swagger UI--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId>
@ApiParam oder @ApiModelProperty in stolzieren?
1 Antworten
Beiden folgenden Anmerkungen, die Arbeit für das hinzufügen von Metadaten zu swagger-ui-docs. Was sollte man bevorzugt und warum? public class MyReq { @ApiModelProperty(required = true, value = "the persons name") @ApiParam(required = true, value = "the persons
Warum springfox-swagger2 UI Sag mir "Unable to infer base-url."
5 Antworten
Warum springfox-swagger2 UI Sag mir Unable to infer base url. soweit ich weiß, ich bin eine typische Swagger spring-boot-Konfiguration. Wie Sie in dem screenshot sehen kann, Fors-fox-url sichern die UI ist example.com/api . HINWEIS: ich bekomme eine
Swagger-UI - "TypeError: Failed to fetch" auf gültige Antwort
4 Antworten
Ich habe gerade nach unten gezogen die neueste Fors aus dem Git-repo (3.0.19) mit: https://github.com/swagger-api/swagger-ui.git und aktualisiert meine API für die neue version. Lief git describe --tags zu bestätigen und meine version ist derzeit: v3.0.19-6-gaab1403 Das problem
Definieren Arrays von mehreren Modellen in Swagger 2.0
2 Antworten
Dies ist mein Erster Ausflug in die Fors bitte so lieb sein. Habe ich die folgenden Definitionen: definitions: Payload: type: object properties: indicators: type: array items: $ref: '#/definitions/Indicator' Indicator: type: object properties: type: type: string computeOn: type:
JSON-API-Beispiele in Swagger 2.0
1 Antworten
Ich versuche zum Beispiel erstellen von Antworten für einen Endpunkt mit Swagger 2.0. 200: description: Successful response schema: type: object $ref: "#/definitions/User" examples: application/vnd.api+json: - data: attributes: full_name: John Appleseed - data: attributes: full_name: Mike Appleseed Mein
swagger 2 spring boot generieren yml Datei
2 Antworten
Ich bin neu zu stolzieren, Verträge und Arbeit auf Spring boot (gradle) Projekt, wo wir beginnen gerade mit der Umgang mit Verträgen. Ich habe verwendet, grails, Liebe, wie Sie können Feld defs in der Domäne und bekommt
Swagger 2.0, wo zu erklären, Basic-Auth-Schema
3 Antworten
Wie definiere ich die Standardauthentifizierung mit Swagger 2.0 Anmerkungen und anzeigen in swagger-UI. In die Ressource, die ich habe: @ApiOperation(value = "Return list of categories", response=Category.class, responseContainer="List", httpMethod="GET", authorizations = {@Authorization(value="basicAuth")}) public Response getCategories(); Sah ich hier:
Nicht in der Lage zu bringen, bis swagger-ui von spring-boot-Anwendung
4 Antworten
Ich habe eine spring-boot-Anwendung, läuft bei mir mit eingebetteten tomcat-server. Ich bin teilweise erfolgreich springfox-swagger integriert mit der app. Wenn ich einen /v2/api-docs , ich bin in der Lage, um zu sehen, alle die Dokumentation der api
Wie generieren Sie stolzieren.json
5 Antworten
Ich bin mit java-spring-boot-framework zum erstellen von REST-api für mein Projekt, und ich bin mit "springfox-swagger2 und springfox-swagger-ui" für die Erzeugung von swagger Dokumentation. Ich bin in der Lage, um zu sehen, meine Dokumentation über die url
"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
Wie zum senden von Authorization-header mit einer Anfrage in Swagger-UI?
3 Antworten
Habe ich eine ASP.NET Web Api 2 Anwendung. Ich fügte hinzu, Swashbuckle (Fors für .NET). Es zeigt meine Endpunkte kein problem, aber um eine Anfrage zu senden, die ich brauche zum anschließen eines Authorization headers auf Anfrage.
Wie format Swagger 2.0-text-Beschreibungen?
1 Antworten
Möchte ich formatieren, meine Swagger API-Beschreibungen, so dass Sie nicht einfach Absätze von text. Vorzugsweise würde ich gerne fügen Sie eine kleine Tabelle. Habe ich nicht gefunden, eine online-Referenz zur text-Formatierung in Swagger-Beschreibungen. Wenn ich starte den
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 kann ich Swagger basierend auf existierenden Briefboten generieren?
3 Antworten
Ich bin die Entwicklung einer REST-API. während der Entwicklung habe ich verwendet, Postbote (chrome-Erweiterung) zu verwenden, und mein Dokument API. Wunderbares Werkzeug, und ich habe die meisten der Endpunkte. Jedoch, als wir in der Nähe von release
Swagger Mock-Server
6 Antworten
Habe ich eine API-Referenz in Swagger-Datei. Ich möchte zum erstellen eines sehr einfachen mock-server, so dass wenn ich zB.: mymockurl.com/users wird es wieder eine vordefinierte json (keine Notwendigkeit, die Verbindung zu einer Datenbank). Was ist der einfachste
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",
Wie öffne ich lokale Dateien in Swagger-UI?
11 Antworten
Ich versuche zu öffnen, mein selbst erzeugten swagger Spezifikation Datei my.json mit swagger-ui auf meinem lokalen Rechner. Also ich heruntergeladen den aktuellen tag v2.1.8-M1 und extrahiert das zip. Dann ging ich in der sub-Ordner dist und kopiert
Wie kann ich "Authorization: Bearer & lt; token & gt;" in einer Swagger Spec (swagger.json)
3 Antworten
Ich versuche zu vermitteln, dass die Authentifizierung/security Schema erfordert Einstellung eine Kopfzeile wie folgt: Authorization: Bearer <token> Dies ist, was ich haben auf der Grundlage der swagger Dokumentation: securityDefinitions: APIKey: type: apiKey name: Authorization in: header security: