Tag: swagger-ui
Swagger-UI ist eine Sammlung von HTML -, CSS-und JavaScript-Objekte, die sich dynamisch generieren von Dokumentation aus einem Swagger-kompatible API
@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( {
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,
Fügen Sie eine header-parameter in Swagger-UI-Dokumentation mit Springfox
3 Antworten
Möchte ich hinzufügen, dass ein header-Feld parameter in der automatisch generierten swagger ui Dokumentation meiner rest-Dienst. Ich benutze Frühjahr und Springfox. public ResponseEntity<User> saveNewUser( @ApiParam(value = "the user to create", required = true) @RequestBody User user) throws
Spring Boot-Swagger-UI - UI-Zugriff Schützen
1 Antworten
Ich habe eine einfache swagger UI zu meinem bestehenden springboot REST-API, indem Sie die folgende Klasse zu meinem code: @EnableSwagger2 @Configuration public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .paths(PathSelectors.regex("/v1.*")) .build() .pathMapping("/")
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
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
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
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-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
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
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
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,
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
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",
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
swagger Fehler: Widersprüchliche schemaIds: Doppelte schemaIds erkannt, für die Typen A und B
5 Antworten
Verwendung von Web-API und mit swashbuckle zu generieren swagger Dokumentation, Ich definiert zwei verschiedene Klassen mit dem gleichen Namen in zwei verschiedenen namespaces. wenn ich öffnen Sie stolzieren Seite in meinem browser sagt es Widersprüchliche schemaIds: Doppelte
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:
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
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-
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
swagger-ui Kein mapping gefunden für HTTP-Anforderung
5 Antworten
Ich versuche zu dokumentieren und vorhandene Rest-API ein Spring-MVC-Projekt (NICHT spring boot!). Meine Anwendung heißt api so http://localhost:9090/api wäre die root-Endpunkt. Da bin ich mit spring-data-rest, auf dass die URL sehen kann ich die json-alle meine ausgesetzt
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
@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
Multipart-Datei-upload mit Springfox und Swagger-ui
4 Antworten
Ich bin mit Spring MVC als rest-controller und ich habe integrierter Swagger-ui mit meinen controller mit Springfox. Ich hätte gerne eine Methode, die in der Lage ist, das hochladen einer Datei über die Swagger-ui-Schnittstelle. Ich brauche nur
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
Nicht Lesen können, swagger JSON aus http://localhost:9000/api-docs/
2 Antworten
Den api-docs war schön früher. Es aufgehört zu arbeiten und jetzt bekomme ich Can't read swagger JSON from http://localhost:9000/api-docs/ Wenn ich das ändern src/main/webapp/swagger-ui/index.html var apiUrl = "http://localhost:8080/swagger-ui/index.html"; Bekomme ich "Can' T read from server. Kann es
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
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
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
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
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,
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 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
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"
Frühling + Springfox + Header-Parameter
2 Antworten
@RequestMapping(...) public Foo getFoo(@HeaderParam("header") final String header) { ... } Hinzufügen eines @HeaderParam Methode parameter wie oben springfox hebt es auf und wenn ich mir die swagger-ui-es hat ein Feld für den header. Das ist genau das,
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
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:
- 1
- 2