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 zu Referenz auf eine ID eines anderen Modells definition in Fors
1 Antworten
Angenommen ich habe einen Benutzer und eine UserType model. Ich möchte hinzufügen, die einen Verweis auf die UserType-ID in die User-Modell. Fors-Dokumentation zeigt, wie der Verweis auf eine andere (ganze) Modell, nicht nur eine seiner Eigenschaften. So
@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( {
Wie nennen swagger codegen programmgesteuert?
1 Antworten
Ich bin der Generierung eines restful java jax-rs-api mit swagger-codgen-cli.jar. Jetzt rufe ich java-jar mit einige Kommandozeilen-Optionen, um dies zu tun. java -jar swagger-codegen-cli.jar generate -i api.yaml -l jaxrs -o ./outputdir Welche gut funktioniert. Aber ich möchte
spring-boot-Anwendung Konfiguration für JaxRs basiert Swagger
2 Antworten
Gibt es ein Beispiel zur Verfügung zu konfigurieren, spring boot+Jersey+JaxRs-Anwendung für Swagger? Bezogen auf diese post, ich habe folgenden code in meine app und bin nicht in der Lage, um das swagger-UI und weder in der Lage,
Howto verwenden von benutzerdefinierten Vorlagen in Fors
2 Antworten
Habe ich diese JavaJaxRs Wörterbuch mit meiner Vorlagen: /templates/JavaJaxRs Bearbeitete ich einige von Ihnen. Und die Sie nutzen wollen, für meine API-generation (Code wurde inspiriert von diesem Ansatz aus https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen-maven-plugin/src/main/java/io/swagger/codegen/plugin/CodeGenMojo.java): System.out.println("Generating API for: " + location); DefaultGenerator
In Swagger, wie kann ich das angeben mehrerer Hostnamen?
2 Antworten
Kann ich mehrere hosts wie: host1: petstore.test.com host2: petstore1.test.com host3: petstore2.dev.com Recht jetzt mein YAML-Datei hat nur einen host-URL. ex: host: petstore.test.com basePath: / YAML hat kein Konzept für hosts InformationsquelleAutor user2598740 | 2016-11-14
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,
Generieren Yaml oder Json-Datei von Swagger Dokumentation
1 Antworten
Habe ich developpe einige Rest-web-service, dokumentiert durch stolzieren, mit Fors-springmvc annotions. Nun, ich will swagger-editor zum generieren von client-side-Rest-web-service-code, aber swagger-editor benötigen, Yaml oder Json-Datei. Wissen Sie, ob es einen Weg gibt, um diese Datei zu generieren
Web-API mit Swagger
2 Antworten
Ich bin neu to.NET /MVC/Web API. Erstellt habe ich eine .Net-Web-API, welche akzeptiert den Eingabeparameter Abfragen der OracleDatabase und gibt das Ergebnis im JSON-Format. Ziemlich viel, die folgenden, einfachen C# - codes. Und es funktioniert perfekt.Mein Controller
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
Generierung von Swagger Dokumentation von bestehenden Java-code?
2 Antworten
Gibt es einen Weg zu erzeugen, Fors-Dokumentation (in YAML - format) aus vorhandenen Java-code? Ich bin derzeit mit YAML-Datei zu generieren Java-API-code, aber ich bin interessiert, ob der umgekehrte Prozess erreicht werden kann. Das ist, wenn ich
Wie kann ich eine Eigenschaft definieren, geben Sie als Liste (list, set, array, collection) von string in mein YAML-definition Swagger
1 Antworten
Schreibe ich ein swagger-definition-Datei für eine API. Die API ist eine für einen GET-request /path/to/my/api: get: summary: My Custom API description: | Gets a List of FooBar IDs produces: - application/json tags: - FooBar responses: "200": description:
Swagger UI: pass custom Authorization-header
4 Antworten
Ich bin mit Swashbuckle und Swagger auf eine ASP.NET Web-API. Ich versuche einen Weg zu finden, übergeben Sie einen Authorization-header mit ein Bearer-token durch Swagger-UI. Ich habe gewesen suchend um, aber alle Antworten scheinen Punkt, an diese
Hinzufügen von Query-String-Parameter zu meinem Swagger-Spezifikationen
3 Antworten
Ich bin mit Swashbuckle (Fors für C#) mit meinem Web-API. Ich habe mehrere BEKOMMEN, End-Punkte, die Rückgabe von Listen und ich dem Benutzer zu ermöglichen, fügen Sie ein perpage Seite und params in der QueryString Beispiel: http://myapi.com/endpoint/?page=5&perpage=10
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
Kein mapping gefunden für Fors-Ressourcen/Konfiguration/Benutzeroberfläche
2 Antworten
Geschlossen. Diese Frage ist off-topic. Es ist derzeit nicht akzeptieren Antworten. mehr. verbessern Wollen dieser Frage? "Update" die Frage so ist es on-topic für Stack-Überlauf. Ich versuche zu konfigurieren swagger-ui nicht in spring-boot-app. Habe ich getan, folgende
Fors - Springfox generiert immer einige response-Nachrichten (401,403...) standardmäßig. Wie kann ich Sie entfernen?
1 Antworten
Ich habe die Steuerung so einfach wie diese: @RequestMapping(value="/async/data", method=RequestMethod.GET, produces="application/json") @ApiOperation(value = "Gets data", notes="Gets data asynchronously") @ApiResponses(value={@ApiResponse(code=200, message="OK")}) public Callable<List<Data>> getData(){ return ( () -> {return dataService.loadData();} ); } Ich hatte erwartet zu haben, nur
Wie definieren leeres array in Fors
2 Antworten
Weiß ich, wie man Arrays von string-Daten in stolzieren wie dieser: "photoUrls" : { "type":"array", "items":{ "type":"string" } } Wird es zeigen Sie eine Ausgabe wie diese: "photoUrls":[ "string" ] Wie man eine Ausgabe wie diese?: "photoUrls":
Swagger-ui-url mit Parameter
3 Antworten
Gewusst wie: übergeben Sie die Basis-url in der form http://localhost:3000/resources/api/?key=aslkdajd1323121lklakskdl zu swagger-ui ? War ich in der Lage, Zugang http://localhost:3000/resources/api aber wenn ich auth filter-und pass-Taste, sagt er Unauthorized. Mit Fors 1.X Pre-populating den parameter durch apiKeyauthorization
Was ist der 'api_key' und wie nutze ich es richtig
2 Antworten
Ich bin Recht neu auf restful-Dienste, und die habe ich nur implementiert, der test-code zu bekommen ServiceStack restful service mit dem Fors-plugin so gut funktioniert, das führt mich zu meiner Frage... innen swagger-ui/index.html es gibt ein Feld
JSON-Schema zu GraphQL-schema-Konverter
3 Antworten
Gibt es irgendwelche Adapter, die Umwandlung von JSON-Schema-schemas (e.g von Fors) zu GraphQL schemas? Es gibt sogar einen offiziellen Artikel über die Verpackung um REST http://graphql.org/blog/rest-api-graphql-wrapper/, aber in der Regel REST bereits beschrieben und Swagger ist das
Wie hinzufügen von API-Beschreibung in Swashbuckle?
1 Antworten
Ich bin neu in Swashbuckl oder Schwadronieren, aber ich habe eine Web-API, die benötigt, um erstellen Sie eine Dokumentation mit Swagger von meinem client. Habe ich bereits erstellt, aber Sie benötigen den API-version-details werden angezeigt, in die
Wie generieren basic Typoskript Schnittstellen von Swagger-schema?
6 Antworten
Ich bin auf der Suche nach einen Weg zu erzeugen, simpel Typoskript-Schnittstellen aus einer Fors-schema. Die meisten Lösungen, die ich finde, sind unnötig kompliziert. Möchte ich erzeugen-Schnittstellen wie diese: export interface IBar { a?: string; b: number;
Swagger-UI - Wie kann ich erweitern, werden alle Operationen, standardmäßig?
5 Antworten
Alle Vorgänge erscheinen zusammengebrochen, wenn ich es öffne und ich will, dass es standardmäßig erweitert. Gibt es eine Eigenschaft, die ich ändern muss, um es zu erreichen? Dies ist mein swagger Bean: @Configuration @EnableSwagger2 public class SwaggerConfig
Fors - Web-API - Optionaler query-Parameter
1 Antworten
[HttpGet] [Route("students")] [SwaggerOperation(Tags = new { "Student" })] [SwaggerResponse(HttpStatusCode.OK, Type = typeof(ResponseModel<IList<Student>>))] [SwaggerResponseExample(HttpStatusCode.OK, typeof(StudentResponseExample))] [SwaggerResponse(HttpStatusCode.InternalServerError)] public IHttpActionResult SearchStudent() { IDictionary<string, string> searchParams = null; searchParams = ControllerContext.GetQueryStrings(); . . . } Den oben genannten API hat drei
Bieten Beispiel-Wert für request-parameter in Fors
3 Antworten
Habe ich eine Methode, die Signatur für eine rest-Methode in einer Spring-Boot-RestController, die wie folgt aussieht: @RequestMapping( value = "/path", method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE ) @ApiImplicitParams({ @ApiImplicitParam( name = "message", value =
Null-Werte auf swagger JSON-Datei
2 Antworten
Ich habe einige Schwierigkeiten mit der JSON-swagger-Dokument generiert durch die Java-annotation (REST ausgesetzt sind, mit Jersey, Serialisierung erfolgt durch Jackson). Blick auf den generierten Gewinn, es enthält null Werte, die bewirken, dass die swagger-UI zum Absturz zu
Was ist der Vorteil der Verwendung von Spring-REST-Docs im Vergleich zu Stolzieren
5 Antworten
Spring REST Docs wurde vor kurzem veröffentlicht und die Dokumentation sagt: Dieser Ansatz befreit Sie von den Einschränkungen durch Werkzeuge wie Swagger So, ich wollte mal Fragen, wenn der Frühling REST Docs ist vorzuziehen, im Vergleich zu
k__BackingField entfernen in C# (gesehen über Swashbuckle / Swagger)
1 Antworten
Ich bin mit Swashbuckle 5 meine ASP.NET webapi-Projekt mit allen Standard-Einstellungen. Es serialisiert meine Methode ist-Ausgabe, um mir zu zeigen das schema der Antwort. Ich bin immer Dokumentation, die wie folgt aussieht: Response Class (Status 200) Model
So erzeugen Sie die Dokumentation mit swashbuckle für WebApi 2 mit Owin
2 Antworten
Habe ich eine WebApi-Projekt mit dieser Artikel. Dinge funktionieren. Aber jetzt ist mein client anzeigen möchten, die Dokumentation mit Swagger. Ich habe versucht zu tun, Konfiguration, sondern Dinge, die nicht funktionieren. nicht immer die Liste von Controllern
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
Swagger parameter-Fehler "ist nicht genau eine von <#/Definitionen/parameter>"?
1 Antworten
Ich bin versucht, zu schreiben eine einfache Fors /Open-API-definition mit den Fors-Editor. swagger: "2.0" info: version: 1.0.0 title: Test API description: Test API schemes: - https host: hipaa.ai basePath: /v1 paths: /comments: post: summary: Your comments description:
Import Fors definition SoapUI community edition?
2 Antworten
Ich bin Herumspielen mit SoapUI (der free/open source edition), um zu sehen, ob es nützlich sein könnte bei der Arbeit für die Art von umfangreichen API-Test das tun wir oft, weil wir gerade jetzt die meisten unserer
Konvertieren Swagger JSON, RAML/YAML
5 Antworten
Wie kann ich umwandeln Swagger JSON, RAML/YAML und validieren? Ich bin nicht auf der Suche nach einem programmatischen Weg, nur eine einmalige Konvertierung. InformationsquelleAutor helios | 2015-09-23
Swagger-ui - Abfrage param
2 Antworten
Ich bin mit Swagger-ui-und Fors core (1.3) für eine jersey-Applikation. Ich habe bestimmte query-Parameter, die ich senden muss mit jeder Anfrage wie post, get, delete... Wie kann ich Standard ? Könnten Sie wählen Sie eine richtige Antwort
Schritte zur Erstellung REST-API-Dokumentation
5 Antworten
Ich versuche zu generieren, Fors-basierte REST-API-Dokumentation (UI) für einige meiner vorhandenen REST-API. Was sind die Schritte, die notwendig oder Voraussetzung für Sie? Ich arbeite an Windows-Betriebssystem. Sie brauchen, um mehr details zu bieten. Sie haben eine bestehende
Sollten Sie Kombinieren Swagger mit HATEOAS/HAL/JSON-LD?
3 Antworten
Ich bin mit Swagger für meine ASP.NET Kern-API mit Swashbuckle, die beschreibt, meine API in ein separates Dokument und bietet eine schöne Benutzeroberfläche, die für alle diese Informationen. Gibt es irgendwelche Vorteile bei der Verwendung von so
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
Multi-line-Literale in swagger-editor?
3 Antworten
Ich versuche, eine multi-line-literal in Swagger-editor (geiles tool übrigens!). post: summary: Translate one or more identifiers description: | Translate one or more identifiers for one entity into the identifiers of another entity. Translate one or more identifiers
REST-API Versionierung mit Swagger 2.0
1 Antworten
Ich brauchte meine Knoten-REST-API werden versioniert. Ich bin mit swagger 2.0 für die Validierung middleware und Dokumentation. Derzeit habe ich nur eine einzige swagger yml-Datei, die für alle gedachte. Bin ich mit url-Präfixen (Versionsnummer: /v1/... /v2/... etc)
Swagger 2.0: Wie das deklarieren einer Eigenschaft definition von type-Modell?
2 Antworten
Möchte ich das deklarieren einer Eigenschaft definition von Art model in Swagger 2.0 Ist diese definition richtig? (speziell Typ: StatusObject Teil) definitions: MyObject: type: "object" properties: id: type: "number" country: type: "string" status: type: StatusObject StatusObject: type:
Nicht link Swagger-ui mein swagger Spring mvc Projekt
2 Antworten
Ich bin derzeit auf der Erstellung einer Rest-API mit Eclipse, Spring-Framework, MVC, und ich nur Hinzugefügt, um mein Projekt zu stolzieren. Kann ich Zugriff auf das json-Ergebnis von swagger, aber ich muss hinzufügen, swagger-ui. Hier sind alle
Swagger POST mit json Körper
1 Antworten
Ich bin versucht, zu schreiben, statisch .json-Datei der server-Antwort mit swagger. Ich bin stecken mit den post-body und wissen nicht, wie Sie es beschreiben. Es sieht so ziemlich ähnlich Grooveshark-api ' s, wo Sie eine haben-Seite und
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.
So definieren Sie eine Karte, stolzieren?
1 Antworten
Arbeite ich an einer API, die auch erzeugt swagger Dokumentation. Das Problem ist, dass aus irgendwelchen Gründen die Anfrage Modell/- schema wird nicht angezeigt, in der swagger-UI, aber ich bekomme keine Fehlermeldung entweder. Ich muss repräsentieren Karte,
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
RESTful-API-Testumgebung mit Swagger
4 Antworten
Ich versuche zu entwickeln, die eine automatisierte Test-suite für eine REST-API. Ich habe gesagt, dass Swagger wäre das richtige Werkzeug, um dies zu tun. Die API entwickelt, mit dem Spring-Framework. Ich kann nicht herausfinden, wie ich mit
Swagger schicken Sie Körper und formData-parameter
2 Antworten
Ich bin mit Swagger 2.0 und ich habe ein problem senden mehrere post-Parameter. Ich habe einen Fors Fehler Operation cannot have a body parameter and a formData parameter und ich weiß nicht, wie es zu lösen ist.
Aktivieren Swagger-UI? Tomcat, SpringMVC, REST
2 Antworten
Meine Konfiguration ist wie folgt: pom.xml <dependencies> <!-- Swagger --> <dependency> <groupId>com.mangofactory</groupId> <artifactId>swagger-springmvc</artifactId> <version>0.9.1</version> </dependency> <!-- Swagger WebJar --> <dependency> <groupId>org.webjars</groupId> <artifactId>swagger-ui</artifactId> <version>2.0.24</version> </dependency> </dependencies> root-context.xml <mvc:annotation-driven/> <beans:bean class="com.mangofactory.swagger.configuration.SpringSwaggerConfig" /> Ich die Bereitstellung der Anwendung in Tomcat
Generierung von Rest-API-Dokumentation mit swagger oder einem anderen tool
3 Antworten
Ich bin auf der Suche nach einem Weg, um Dokument-meine Rest-APIs. Mein server ist ein Tomcat/Spring-server und der Rest-APIs werden implementiert unter Verwendung von Jenkins. Swagger scheint eine ziemlich Coole Lösung, aber ich kann nicht herausfinden, wie