Tag: swagger
Swagger ist eine framework-Implementierung für die Beschreibung, Produktion, Konsum, und Visualisierung von RESTful-web-services auf Basis Offener API-Spezifikation
Wie kann ich einstellen, eine Beschreibung und ein Beispiel in Swagger mit der Swagger Anmerkungen?
3 Antworten
Ich bin der Erstellung einer REST-Api mit Spring boot und die automatische Generierung von Fors Dokumentation in Steuerungen mit swagger codegen. Allerdings bin ich nicht in der Lage, eine Beschreibung und ein Beispiel für einen parameter vom
Gewusst wie: verweisen auf ein response-Objekt mit swagger?
1 Antworten
Kann ich dies tun: parameters: avatarSizeParam: name: size in: query description: Size of avatar. enum: [32, 64] required: false type: integer format: int32 paths: /my/path/avatar: get: parameters: - $ref: '#/parameters/avatarSizeParam' Gut. Swagger legt eine parameters key, wo
Gewusst wie: ausblenden der parameter, die in stolzieren?
6 Antworten
hat jemand erfolgreich ist, um einen parameter ausblenden von Dokumentation? Ich habe ein Problem hier, aber mit @ApiParam(access="internal", required=false) vor @HeaderParam schien nicht zu funktionieren. InformationsquelleAutor yevgeniy mordovkin | 2014-04-02
SwaggerSpringMvcPlugin funktioniert nicht auf Spring MVC
2 Antworten
Ich verwende folgende Komponenten in meinem REST-back-end-Projekt: Spring MVC: 4.1.2.RELEASE (spätestens) Hibernate4 Objekt-Mapper: 2.4.3 (spätestens) Swagger: 0.9.1 (spätestens) Java ee-web-api: 7.0 (servlet 3.1) Ich bin mit der XML-basierte bean-Konfiguration, und ich war in der Lage, das basic-setup
Wie set @ApiModelProperty Datentyp String für Swagger Dokumentation
2 Antworten
Bin ich mit Spring MVC (über Spring-Boot) und haben integrierte Swagger API-Dokumentation mit dem Fors-spring-mvc-Bibliothek. Habe ich eine Klasse, die wie folgt aussieht: @ApiModel public class CartItem { ... private Money listPrice; //joda money class @JsonSerialize(using =
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
Wie integrieren swagger-ui in meiner Anwendung
5 Antworten
Ich versuche mich zu integrieren swagger mit Kamel-Projekt in diesem Beispiel https://github.com/smparekh/camel-example-servlet-rest-tomcat Wie greife ich auf swagger-ui mit der in diesem Beispiel-Projekt ? Ich delopyed die war-Datei im tomcat. und Zugang http://localhost:8080/camel-example-servlet-rest-tomcat/api-docs bekomme ich diese ... {"apiVersion":"1.2.3","swaggerVersion":"1.2","apis":[{"path":"/Benutzer","description":"User-rest-service"}],"info":{"title":"User
Swagger UI-Fehler: Unable to fetch API Listing
1 Antworten
Bin ich dokumentieren eine REST web-API mit Swagger. Ich habe heruntergeladen die petstore Beispiel. Es besteht aus den resources.json die Verweise pet.json und user.json: { "apiVersion":"0.2", "swaggerVersion":"1.0", "basePath":"http://petstore.swagger.wordnik.com/api", "apis": [ { "path":"/pet.{format}", "description":"Operations about pets" }, {
Definieren Sie ein response-Objekt mit einem array in YAML mit Swagger-Editor
1 Antworten
Arbeite ich an einer API-definition in Swagger-Editor mit YAML. Ich bin versucht zu vertreten, die folgende Antwort Körper: { success: true, ids: [123456, ...] } und dies ist, was mein YAML aussieht: definitions: SuccessfulResponse: type: object properties:
Swagger und Datum
1 Antworten
Ich bin neu zu stolzieren und Schreibe meine erste Skillung. Ich habe festgestellt folgenden swagger "Datum" - Typen*: ------------------------------------------------ | Common name | Swagger spec 1.2 | ------------------------------------------------ | string | string | ------------------------------------------------ | date |
Gute Erholung-code-Generierung und Dokumentation-tool
4 Antworten
Habe ich zu überlegen, eine Dokumentation, ein Werkzeug für den Aufbau eines backend für eine web-service verwendet werden, in der mehrere clients zusammen mit OAuth und die Möglichkeit, mehrere Revisionen. Ich wusste bereits über die Imkerei, aber
Hinzufügen Grundlegende Berechtigung für Swagger-UI
5 Antworten
Ich habe derzeit ein Fors-Projekt, aber ich habe Probleme beim hinzufügen von einige grundlegende Berechtigung. Currenty, wenn Sie klicken Sie auf die "Versuchen Sie es!" - Taste, die Sie anmelden müssen, um ein Konto für den Zugriff
Swagger-UI-Authentifizierung-token zur API-Aufruf im header
4 Antworten
Ich bin neu zu Stolzieren. Ich bin mit Swagger-UI generieren swagger Dokumentation. Ich habe zwei API-Aufrufe. Ersten Aufruf zu generieren, token, basierend auf dem Benutzernamen und Passwort. Zweiten Anruf muss token generiert durch first call. Wie ich,
Mit Swagger mit Kolben
7 Antworten
Gibt es eine Möglichkeit generieren eine RESTful API in Kolben mit Swagger? Es ist dieser wenn die API schon vorhanden ist, oder dieser, generieren ein. Als solche aber, dies ist sehr viel ein", schlage mir eine Bibliothek"
Validierungs-Fehler: Daten nicht übereinstimmen schemas von 'oneOf'
1 Antworten
Ich bin immer der Fehler Data does not match any schemas from 'oneOf' mit der folgenden Skillung: { "info": { "version": "1.0.0", "title": "REST API" }, "paths": { "/doit": { "post": { "responses": { "200": { "description":
Swagger: map <string, Object>
2 Antworten
Muss ich das Dokument mit Swagger eine API, die verwendet wird, sowohl als input-und output-Karten von Objekten, indiziert durch die string-Schlüssel. Beispiel: { "a_property": { "foo": { "property_1": "a string 1", "property_2": "a string 2" }, "bar":
Wie schalten Sie die swagger-ui in der Produktion
3 Antworten
Habe ich swagger eingesteckt, um meine spring-boot-Anwendung. Spring boot können Sie property-Dateien für jede Umgebung, die Sie haben. Gibt es eine Möglichkeit zu deaktivieren swagger für eine Produktionsumgebung? InformationsquelleAutor user301693 | 2016-06-13
Validierung von JSON gegen Swagger-API-schema
3 Antworten
Erstellte ich eine API spec von einigen von JSON-Dateien und ich bin versucht, um zu testen, ob die Dateien validieren, gegen die API spec. Gibt es einige gute tools für die Validierung mit JSON-Schema, aber ich habe
Mit Javadocs generieren Swagger Dokument
2 Antworten
Will ich bauen Fors Dokumentation für ein bestehendes set von RESTful-APIs. Ich habe folgende Anforderung: Generieren Swagger Doc-offline (ich habe http://kongchen.github.io/swagger-maven-plugin/). Dieses plugin hilft mir, mich zu generieren, Fors-Dokumentation, die während der Kompilierung. Lesen der vorhandenen Javadoc,
wie Sie hinzufügen token-auth zu stolzieren + django rest framework?
6 Antworten
Ich bin mit beiden großen tools DRF und Django-REST-Swagger, aber ein paar meiner API Ansichten sind unter token-Authentifizierung. So, jetzt möchte ich zu meinen swagger doc Seite meiner API die Möglichkeit zum testen dieser token-auth-api-urls, einschließlich der
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:
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
Swashbuckle-parameter-Beschreibungen
3 Antworten
Ich bin mit SwaggerResponse Attributen zu schmücken api controller-Aktionen, das alles funktioniert Prima, aber wenn ich mir die generierte Dokumentation das Feld Beschreibung für Parameter leer ist. Ist es eine Attribut-basierte Ansatz zur Beschreibung von action-Parametern (anstatt
Deaktivieren Swagger mit Spring MVC
3 Antworten
Ich bin mit Swagger mit Spring MVC. Ich möchte selektiv deaktivieren swagger in bestimmten Umgebungen (z.B. Produktion). Wie kann ich das tun? So ziemlich nichts. Ich bin Total neu zu Stolzieren. Ich habe versucht, um zu sehen,
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
Mit einem API-Key & Geheimnis für Fors-Security-Schema
1 Antworten
Swagger unterstützt die Sicherheit der api-key, aber das scheint nur auf einen einzigen parameter. Gibt es eine Möglichkeit zu definieren, einen Satz von Parametern (key und secret) , erwartet als Parameter in einer Anfrage? Oder ist die
Enum in Fors
5 Antworten
Frage ich mich, wie Dokument-Enumerationen in Fors. Laut JavaDoc Den Datentyp. Finden Sie in der Dokumentation für die unterstützten Datentypen. Wenn der Datentyp ein eigenes Objekt, legen Sie dessen Namen, oder nichts. Im Fall einer enum-Nutzung 'string'
Verwenden JWT (Authorization: Bearer) in Fors in ASP.NET Kern
3 Antworten
Ich bin der Erstellung einer REST-api in ASP.NET Core 1.0. Ich war mit Swagger zu testen, aber jetzt habe ich Hinzugefügt JWT Berechtigung für einige Strecken. (mit UseJwtBearerAuthentication) Ist es möglich, ändern Sie den header der Swagger-Anforderungen,
Wie kann ich url-Pfad in Swashbuckle/Swaggerwork wenn api serviert, von innen ein anderes Projekt?
1 Antworten
alle. Ich bin versucht zu dokumentieren, eine WebApi 2 mit Swashbuckle-Paket. Funktioniert alles Super, wenn die API ausgeführt wird, indem sich also localhost/api/swagger bringt mich zu ui und localhost/api/swagger/docs/v1 zu json. Jedoch die producation-app initialisiert das gleiche
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
Wie generieren offline-Swagger-API-docs?
5 Antworten
Ich habe eine spring-boot-MVC-java-Web-app. Ich habe in der Lage zu integrieren Springfox für die API-Dokumentation. Kann ich optisch sehen alle APIs, wenn der server hochgefahren ist und läuft. Wie kann ich generieren OFFLINE-swagger-API-Dokumentation? Hinweis: ich möchte nicht
"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.
Generieren Swagger Dokument für bestehende NodeJS server
3 Antworten
Laut Swagger websitegibt es zwei Ansätze: Bottom-up und Top-down. Ich habe eine vorhandene NodeJS-server, ich möchte zur Implementierung in der Azure-Umgebung, verlangen, dass ein swagger-Dokument-API (APP). Kennt jemand ein tool für die Generierung der swagger mit dem
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
Wie zum senden von benutzerdefinierten Header mit Anfragen in Swagger-UI?
8 Antworten
Habe ich einige Endpunkte, die in der API - /user/login/products. In Swagger-UI poste ich email und password zu /user/login und als Antwort erhalte ich ein token string. Dann kann ich kopieren Sie den token aus der Antwort,
Unable to get Swagger-UI-Arbeit mit Spring boot
5 Antworten
Ich versuche Swagger-UI-Arbeit mit Spring Boot 1.2.1. Ich folgte den Anweisungen auf https://github.com/martypitt/swagger-springmvc und ich fügte @EnableSwagger auf meine Feder config. Ich derzeit wieder JSON-wenn ich http://localhost:8080/api-docs aber kein schönes HTML. Ich bin mit Maven und fügte
Wie kann ich beschreiben komplexe json-Modell in Fors
1 Antworten
Ich versuche, Stolzieren, um zu beschreiben, web-api, die ich gerade Baue. Das problem ist, dass ich nicht verstehen kann, wie Sie beschreiben komplexe json-Objekt? Zum Beispiel, wie Sie beschreiben diese Objekte: { name: "Jhon", address: [ {
Wie zu entkommen, Doppelpunkte und andere Sonderzeichen in eine YAML-string?
2 Antworten
Habe ich die folgenden YAML-fragment: description: | "API for bean consuming applications. Examples: painted pony, lima bean" Swagger-editor interpretiert den Doppelpunkt (:) als Sonderzeichen, trotz der Anführungszeichen. Gemäß der akzeptierten Antwort auf diese Frageder Doppelpunkt sollte nicht
Art-API-Methoden in Swagger-UI
3 Antworten
Ich finde keine funktionierende Beispiel, wie man Folgendes erreichen: Ich möchte, dass meine API-Methoden in der Swagger-UI sortiert entweder durch Methoden (GET-POST-PUT-DELETE) ODER/UND alphabetisch. So weit, alle Methoden angezeigt, die in einer zufälligen Reihenfolge, auch nicht im
Wie man Swagger zum senden von API-key als http, anstatt in der URL
3 Antworten
Ich bin mit swagger mit servicestack aber ich bin immer ein 401 unbefugte Fehler von meinem /Ressourcen-URL, weil es erfordert einen API-Schlüssel. Wenn ich mich nicht Irre, laut der Dokumentation ich sollte supportHeaderParams zu wahren sowie die
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
Konvertieren einer Stolzieren YAML JSON-Datei von der Befehlszeile aus
4 Antworten
Ich würde gerne konvertieren Swagger YAML Datei zu JSON von der Befehlszeile aus. Der plan ist, verwenden Sie diese Befehlszeile während ein CI-job. Ich habe in google gesucht und fand viele Lösungen, aber die meisten von Ihnen
Web-API mit OAUTH mit Swagger / Swashbuckle
3 Antworten
Ich bin versucht, meine Web-API-Projekt zu verwenden, Fors 'ziemlich' Dokumentation, etc. (http://swagger.io/) Ich bin mit Swashbuckle .NET, Installation über NuGet und die version, die ich verwende, ist 4.0.1 Habe ich in der Lage zu installieren und zu
Generieren WebAPI Dokumentation in Fors json-format
3 Antworten
Habe ich eine WebAPI mit .Net 4.5 und dokumentieren wollen, die diese API verwenden Swagger. Ich habe swagger-ui in meine .Net-Projekt. Wenn ich jetzt navigieren Sie zu ../swagger-ui/index.html erfolgreich öffnet pet-store-api-docs (json) in swagger-UI-format. Meine Frage ist
Wie erstellen Sie ein stolzieren-schema umfasst eine Reihe von unterschiedlichen Typen
2 Antworten
Versuche ich zu definieren, ein stolzieren-schema-definition für ein Objekt, das enthält ein array von Objekten unterschiedlicher Typen. Hier ist die json-schema für ein template-Objekt (und alle zugehörigen Objekt-Typen). Ich bin mir bewusst, dass swagger nicht unterstützt oneOf
Swagger-API die query-string
2 Antworten
Möchte ich für die Bereitstellung einer API die query-string.Dies ist die API v1/products?q=circuit breaker&locale=en-GB&pageSize=8&pageNo=1&project=GLOBAL Hier ist, wie ich die Umsetzung "/v1/products?q={searchText}&locale={ctrCode}&pageSize={pageSize}&pageNo={pageNo}&project={project}&country={country}":{ "get":{ "tags":[ "Search Text" ], "summary":"Get Products by searching text, countrycode, page number, pagesize, project and
so exportieren Sie stolzieren apis in postman
2 Antworten
War ich neulich schrieb restful apis mit SpringMvc und swagger-ui(v2).Heute, mir ist nur aufgefallen das button Import über den Postboten.Und ich klickte es, ich sah nur den Kommentar "Import Briefträger Sammlung, Umwelt -, Daten-dump, den curl-Befehl, oder
Swagger 2.0: Wie geben Sie einen input-parameter vom Typ "object"
2 Antworten
Mit Swagger 2.0, die ich versuche zu geben Sie einen input-parameter vom Typ Objekt: code-snippet: paths: '/thingies/{thingy_id}.json': put: summary: Update an existing thingy description: Updates an existing thingy parameters: - name: thingy_id description: ID of the thingy