Tag: swagger
Swagger ist eine framework-Implementierung für die Beschreibung, Produktion, Konsum, und Visualisierung von RESTful-web-services auf Basis Offener API-Spezifikation
Spring Boot + Springbox swagger Fehler
3 Antworten
Ich habe eine spring-boot-Projekt integrieren wollen, mit swagger via springbox. Habe ich meine spring-boot-app und läuft alles gut. Aber nachdem ich Hinzugefügt springbox, es kann nicht passieren unit-test. Hier sind die details, die ich Hinzugefügt im Projekt.
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",
Wie integrieren Swagger mit Maven + Java + Jersey +Tomcat
3 Antworten
Ich kann nicht scheinen, um zu verstehen, wie zu integrieren Swagger zum generieren der API-Dokumentation. url: ####:8080/MyService/rest/users/getall Ich habe Anmerkungen zu code und der Abhängigkeit. Ich versuche, besuchen Sie: ####:8080/MyService/rest/aber sagt, seine nicht gefunden. //web.xml <servlet> <servlet-name>mycompany-users-serlvet</servlet-name>
Web-Api - Swagger-Dokumentation-Fehler 500
6 Antworten
Wenn ich Zugang zu Fors url: http://localhost:28483/swagger/ui/index, wird dieser Fehler erzeugt: 500 : undefined http://localhost:28483/swagger/docs/v1 Irgendwelche Ideen? AKTUALISIERT: Sehen Sie dieses detail Fehler im firebug: Not supported by Swagger 2.0: Multiple operations with path 'api/BimModel' and method
Nicht in der Lage zu bekommen springfox-swagger-ui arbeiten mit Spring MVC
4 Antworten
Verbrachte ich ein paar Tage suchen und nicht in der Lage gewesen, eine Lösung zu finden, die meisten Beispiel befassen sich mit spring-boot und gradle, ich bin nur mit spring mvc und maven. Wenn ich entfernen Sie
Wie integrieren swagger mit jersey + spring-boot
3 Antworten
Ich bin mit springboot + Trikot für web restful-Implementierung. Nun bin ich dabei, zu integrieren swagger in unserer Anwendung. Ich habe folgende. @Configuration @EnableSwagger2 public class JerseyConfiguration extends ResourceConfig { public JerseyConfiguration(){ register(HelloworldAPI.class); configureSwagger(); } private void
Swagger integration in Dropwizard
2 Antworten
Ich bin ziemlich neu zu drop wizard (dropwizard.io) & gerade abgeschlossen Ihre tutorial. Ich würde gerne integrieren Swagger (prahlen.io) in diesem Beispiel-app. Ich fand: github.com/federecio/dropwizard-swagger-sample-app github.com/federecio/dropwizard-swagger Den generierten JSON-scheint Recht ähnlich zu sein, allerdings kann ich nicht
Response-Modells für das spezifische status codes mit Swagger
3 Antworten
Ich bin mit Swagger zu dokumentieren, meine REST-API (mit asp.net web-api-2). Gibt es eine Möglichkeit in Fors zu geben-response-Modelle für jeden möglichen Antworten an, die für einen bestimmten api-Aufruf? Ich bin Anmerkungen zu den status-code der Antwort
Swagger Dokumentation für das Frühjahr interface Pageable
6 Antworten
Entwickelt ich ein microservice mit Spring Boot. Die Dokumentation für die REST-API mit Swagger. Einige REST-Ressourcen nutzen Frühling Konzepte zu bieten, pagination kostenlos. Unten ist ein Beispiel: @RequestMapping(value = "/buckets", method = GET) public PagedResources list(Pageable pageable,
Wie zu generieren der client-code mit pompös-codegen-plugin (maven -)?
3 Antworten
Brauche ich, um zu generieren, eine server-stub-code in eclipse erstellt und mit Fors-codegen-plugin für maven) . Sie können bitte helfen, wie es zu tun ? und welche Konfiguration benötigt( in pom.xml). Der Titel sagt generieren der client-code,
Zum umleiten von Stamm-url auf /Fors/ui/index?
7 Antworten
Ich habe eine WebApi-Projekt mit Swashbuckle auf installiert es. Im Standard-setup, muss ich im browser öffnen http://localhost:56131/swagger/ui/index zu meiner Operationen Beschreibung und test Seite. Ich will es zugänglich von der Wurzel der site: http://localhost:56131/. Wie kann ich
oneOf in Swagger-schema funktioniert nicht
3 Antworten
Möchte ich definieren PaymentMethod als unten. Ist oneOf unterstützt stolzieren.yaml? PaymentMethod: oneOf: - $ref: '#/definitions/NewPaymentMethod' - $ref: '#/definitions/ExistPaymentMethod' Den ExistPaymentMethod haben nur id, und cardNumber wo NewPaymentMethod keine id, aber alle anderen details, wie z.B. cardNumber, cardholderName,
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
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
Senden dynamische benutzerdefinierte Header in swagger-UI-try-outs
1 Antworten
Ich bin mit swagger in java. Lese ich einen header namens " callerId durch requestAttributes in den code. Ich bin nicht mit dem Kopf durch die annotation @HeaderParam. weil dies ein Grund, warum der header-Abschnitt ist, nicht
Swagger doc für api-Reaktion (Typ-Liste)
1 Antworten
Ich bin mit swagger zum generieren der Dokumentation von mein-REST-API. Aber ich habe Probleme angeben, die Reaktionen von einigen API-Aufrufe. Dies ist mein code: @GET @Path("/self/activities") @Produces(MediaType.APPLICATION_JSON) @ApiOperation(value = "Get all activities created by this user", notes
Api-annotation die Beschreibung ist veraltet
5 Antworten
In Fors, @Api annotation ist description ist veraltet. Gibt es eine neuere Möglichkeit, die Beschreibung? Welche Version beziehst du dich auf? github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X oder vielleicht docs.stolzieren.io/swagger-core/current/apidocs/index.html?io/... helfen könnte Ich bin mit version 2.4.0 (springfox) Wie ich sehen kann,
swagger @ApiModelProperty Beispiel-Wert für die Liste<String> Eigentum
6 Antworten
Ich habe eine Klasse, in der es ist eine Eigenschaft, die List<String> public class MyClass { .... @ApiModelProperty(position = 2) private List<String> productIdentifiers; .... } Dieser code erzeugt die Beispiel-Werte wie folgt: { "customerId": "1001", "productIdentifiers": [
Swashbuckle/Swagger + ASP.Net Kern: "Fehler beim laden der API-definition"
8 Antworten
Entwickle ich eine ASP.NET Core-2-Anwendung und enthalten Stolzieren. Alles funktionierte gut, bis ich eingeführt, eine Methode, die ohne explizit definieren Sie die HTTP-Aktion: public class ErrorController : Controller { [Route("/error")] public IActionResult Index() { return StatusCode(500, new
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
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
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-
So exportieren Sie ein Swagger JSON/YAML-Datei von Swagger-UI?
1 Antworten
Wie kann ich exportieren ein Stolzieren-definition-Datei (es sollte ein JSON oder YAML-Datei)? Ich bin gefragt und ich habe nur oberflächliche Kenntnisse über Swagger. Wir haben einen Endpunkt suchen, wie http://example.com//swagger/ui/index#! die wie folgt aussieht (der screenshot ist
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
Swagger 2.0 - wie man "die ein oder andere" parameter erforderlich?
4 Antworten
Habe ich ein swagger 2.0 resource unten definiert. Wie kann ich machen "param1 oder param2" erforderlich? Anrufer passieren, entweder param1 oder param2. /some/res: put: summary: some resource responses: 200: description: Successful response schema: $ref: '#/definitions/SomeResponse' parameters: -
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>
ASP.NET Core - Swashbuckle schaffen nicht Gewinn.json-Datei
8 Antworten
Ich habe Probleme damit, die Swashbuckle.AspNetCore (1.0.0) Paket erzeugen keine Ausgabe. Ich lese die Angeberei.json-Datei geschrieben werden sollten '~/swagger/docs/v1'. Aber ich bekomme keine Ausgabe. Begann ich mit einer neuen Marke ASP.NET Kern-API Projekt. Ich sollte erwähnen, das
@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
Wie Sie angeben, ob ein Feld optional oder erforderlich stolzieren?
2 Antworten
Wie definiere ich in Fors, wenn ein Feld optional oder erforderlich und was ist der Standard? InformationsquelleAutor user79074 | 2016-10-18
Die Einstellung der Api-Version mit Swagger-UI
3 Antworten
Habe ich eine REST-API entwickelt, die durch die Verwendung von Jersey und dokumentieren wir die REST API, durch swagger-ui. Leider hatten wir nicht starten Versionierung der API von Tag 1. Wir werden jetzt versuchen, fügen Sie die
So ändern Sie die Basis-url von Swagger in ASP.NET Kern
5 Antworten
Standardmäßig beim aktivieren von swagger in ASP.NET Kern-Projekt, es ist verfügbar auf url: http://localhost:<random_port>/swagger/ui Ich würde gerne auf einen anderen Basis-url statt /swagger/ui. Wie/wo kann ich konfigurieren, dass? Fand ich, dass für ältere Versionen können Sie die
Konfigurieren von oAuth2 mit Passwort flow mit Swagger-ui in spring boot rest-Anwendung
4 Antworten
Ich spring boot rest-api (Ressourcen), die verwendet einen anderen spring-boot-Zulassung-server habe ich Hinzugefügt, Swagger config, um die Ressource zu Anwendung Holen Sie sich eine schöne und schnelle Dokumentation/test-Plattform für die rest-API. mein Swagger config sieht wie folgt
Fors-PHP für die Generierung der JSON-Datei für Swagger-UI
2 Antworten
Ich bin versucht, Fors-PHP für die Generierung von JSON-Dateien , so dass ich es verwenden können, mit Swagger-UI für die automatische Dokumentation. Ich habe versucht den link :- https://github.com/zircote/swagger-php Auch habe ich versucht zu umgehen mit der
Mit Swagger mit WCF REST
3 Antworten
Ich habe einen WCF-REST-basierte service-das möchte ich hinzufügen-Gehabe. Habe ich installiert Swagger.NET Paket, mein Projekt verwenden .NET 4.0. Ich habe auch ermöglicht, XML-Dokumente, etc... aber jetzt bin ich nicht sicher der beste Weg von hier. Wenn ich
Warum ist der swagger-ui nicht mit meinen kommentierten REST-Methoden?
2 Antworten
Ich habe Probleme beim konfigurieren von swagger zu sehen, wie meine REST-Methoden. Ich arbeite in Eclipse und Tomcat 7. Ich habe die folgende einfache REST-Methode/Klasse: package com.rest; import javax.ws.rs.GET; import javax.ws.rs.Path; import com.wordnik.swagger.annotations.Api; import com.wordnik.swagger.annotations.ApiOperation; @Api( value="/",
REST-API - Swagger + Java + Jersey falsche Liste Weg und zusätzliche apis
2 Antworten
In meinem Projekt bin ich mit Maven, Jetty, Swagger, Java und Jersey für die Erstellung von REST-API. Ich benutze auch Swagger zu erstellen gut aussehende Dokumentation für mein API. Fast alles ok ist, statt drei Punkte. Bei
so integrieren Sie stolzieren mit meiner express-Anwendung
4 Antworten
Immer ich verwendet, um meine Knoten side services zu einigen anderen teams mit der richtigen Dokumentation. Basierend auf dieser Dokumentation werden Sie meine Dienste nutzen. Bezüglich dieser, wenn ich Sprach mit einigen anderen Kerl. Er schlug mich
swagger Feld Datum vs-Datum-Uhrzeit-Feld
2 Antworten
Ich bin mit swagger zu testen, meine rest-api, eine der Eigenschaft meiner Person-Klasse ist ein Datumsfeld aus, das ich benötige das Datum im yyyy-mm-dd-format , aber swagger Modell schema zeigt dieses Feld als Datum-Zeit statt date-Feld, also
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
Immer Keine 'Access-Control-Allow-Origin' mit Swagger und Vorarbeiter Rails server
2 Antworten
Ich habe mein server läuft auf 0.0.0.0:5100. Wenn ich versuche, auf mein Swagger docs, bekomme ich die folgende Fehlermeldung in der Konsole: XMLHttpRequest cannot load http://0.0.0.0/api/v1/types.json. No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'http://0.0.0.0:5100'
Web-Api zum hinzufügen einer Header-parameter für alle API in Fors
4 Antworten
Suchte ich nach Möglichkeiten zum hinzufügen von ein Anfrage-header-parameter werden würden automatisch Hinzugefügt, um jede Methode, die in meinem web-api finden konnte ich aber nicht klar. Beim suchen habe ich festgestellt, dass die Methode OperationFilter() hat, etwas
Konfigurieren von Swagger UI, Jersey und Datei-upload?
2 Antworten
Ich habe eine Jersey-Dienst mit einem Datei-upload-Methode sieht wie folgt aus (vereinfacht): @POST @Path("/{observationId : [a-zA-Z0-9_]+}/files") @Produces({ MediaType.APPLICATION_JSON}) @Consumes(MediaType.MULTIPART_FORM_DATA) @ApiOperation( value = "Add a file to an observation", notes = "Adds a file to an observation and
Wie zu verwenden swagger-ui mit service bereitgestellt in tomcat läuft auf eclipse
1 Antworten
Habe ich eine REST api ausgeführt http://localhost:8080/MyService und sehen können, die JSON-produziert von swagger bei http://localhost:8080/MyService/api-docs. In dem Server-Projekt in eclipse habe ich geändert web.xml enthalten die Cors-filter: <filter> <filter-name>CorsFilter</filter-name> <filter-class>org.apache.catalina.filters.CorsFilter</filter-class> </filter> <filter-mapping> <filter-name>CorsFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> aber
Nicht unterstützt von Swagger 2.0: Mehrere Operationen mit Pfad
6 Antworten
Habe ich integriert swagger in WebApi 2 Anwendung. Es funktioniert, wenn die Anwendung verfügt über Einzel-controller. Wenn ich zusätzlichen zweiten controller in der Anwendung. Ich bekam folgende Fehlermeldung : Ist ein Fehler aufgetreten.","ExceptionMessage":"Nicht unterstützt Swagger 2.0: Mehrere
So erzeugen Sie C# - client von Swagger 1.2 Skillung?
1 Antworten
Scheint es Millionen von Möglichkeiten gibt für jede Plattform, aber ich bin kämpfen, um eine einfache Lösung für C#. Alle die, die ich gefunden habe, scheinen mir Mühe gegeben: entweder Sie haben einfach nicht funktionieren (z.B. http://swaggercodegen.azurewebsites.net/),
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:
Kann die Basis-URL ändern in Stolzieren?
2 Antworten
Ich habe derzeit umgesetzt Swagger und ich habe bemerkt, dass die Basis-url für die Ressourcen ist fest in der JSON-Ressource-Dateien, idealerweise würde ich gerne dem Benutzer die Möglichkeit zum ändern der Basis-url für verschiedene json verbages. So,
Ausschließen, Modelle oder Eigenschaften von swagger Antwort
2 Antworten
Ich verwendet swagger in meinem apache-cxf-Projekt , verwendet @Api und @ApiOperations und @ApiParam Annotationen und generiert einen api-doc für die rest-Dienste. Aber ausschließen will ich einige Felder wie EntityTag, StatusType und MediaType usw von Modellen Attribut oder