Customize Swagger-UI to serve multiple Json Files
Hello Folks, I have an application with many Rest Services and Models and now i want to generate Swagger Documentation for these services, and i just went with Swagger. I added swagger and swagger-ui to my Application and at first it looks Perfect, but once i finished adding all my Services i ended up with some problems, the major problem is the Swagger-UI , because Swagger generate one single json file api-docs for all the services, this files got big and so when i access the swagger-ui it crashes because the file is so big and the browser runs out of memory. i searched but i didn't find a solution for the swagger-ui but i found a maven plugin that can generate mutiple json files : maven-swagger-plugin so now i have different files containing different documentation for my services, but my problem now is how can i make swagger-ui dynamic so i can order one json file per time and render it in the ui. thanksSwagger show file content via @ExampleProperty annotation
I am using swagger 3.0.0-Snapshot to create documentation for my Spring Boot application. My maven dependencies are <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>3.0.0-SNAPSHOT</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>3.0.0-SNAPSHOT</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-spring-webmvc</artifactId> <version>3.0.0-SNAPSHOT</version> </dependency> My swagger config class is as simple as possible: @Configuration @EnableSwagger2WebMvc public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .useDefaultResponseMessages(false) .select() .apis(RequestHandlerSelectors.basePackage("com.mycompany.cs")) .paths(PathSelectors.any()) .build() .pathMapping("/") .useDefaultResponseMessages(false); } And my controller method has the following annotation: @ApiOperation(value = "Hello world", httpMethod = "POST") @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", examples = @Example(value = @ExampleProperty(mediaType = "application/json", value = exampleValue))) }) It is working and shows in Swagger UI "Example Value" field value that has constant string exampleValue that is private static String. The question is how to pass the content of json file that is in resources folder to @ExampleProperty value? I tried to read file content in static block and pass it to initialize final String with it, but then the compiler says that "Attribute value has to be constant". The content of json file must be shown in example field in Swagger UI.
Swagger UI: authorization modal logout/authorize issue
Library version: swagger-ui-dist#3.32.5 Problem : It is not possible to authorize again inside same 'Authorization modal' after logout is clicked Steps to reproduce : 1. Click 'Authorize' button in Swagger UI 2. enter proper client id and client secrets. 3. check necessary scopes 4. click Authorize button below. 5. do proper auth actions in a separate tab. 6. After successful auth process second tab is closed and 'Logout' button appears instead of 'Authorize' (meanwhile auth token endpoint is accessed with proper authorization code) 7. click 'Logout' button (it should be disappear and 'Authorize' should appear. Also clientid+clientsecret + checkboxes remain with the same data) 8. click Authorize. 9. do necessary auth actions in separate tab 10. see next error response in 'Authorization modal' :AuthErrorError, error: invalid_grant, description: Authorization code is invalid or expired. Investigation results: 1. oauth2-redirect.html endpoint sends proper authorization code back to main tab. 2. however authActions.authorizeRequest will receive auth code from first authentication try (steps 1-5) 3. It seems redux state is not properly updated during recieving callback fromoauth2-redirect.html 4. issue is reproducible on local environment as well as in swagger hub.
How we can display single API inside Swagger UI or Swagger Widget? Swagger Widget for Web available?
I am trying to create a Swagger API documentation like the attached screenshot. I have a swagger endpoint. I want to customize Swagger UI to display API document as follows: How can I create this kind of documentation? Is there any product like Swagger Widget which I can put on webpages and try out Single APIs? I am using React, ASP.Net Core and Swasbuckle Core. Pls let me know. Thanks in advance.CXF Swagger2Feature return the same swagger.json
am trying to generate swaggger documentation for our APIs. what i did is creating a bean based on the org.apache.cxf.jaxrs.swagger.Swagger2Feature: <bean id="MySwagger2Feature" class="org.apache.cxf.jaxrs.swagger.Swagger2Feature" abstract="true"> <property name="scanAllResources" value="true"/> <property name="title" value="Swagger API for Restful Services"/> <property name="description" value="Swagger API for Restful Services"/> <property name="version" value="1.0.0"/><!--TODO:: version --> <property name="prettyPrint" value="true"/> </bean> and then for each Service(Endpoint) i created a separate bean that extends the parent bean. exp <bean id="dashboardSwagger" parent="MySwagger2Feature"> <property name="basePath" value="/services/rest/dashboard"/> </bean> <bean id="usersSwagger" parent="MySwagger2Feature"> <property name="basePath" value="/services/rest/users"/> </bean> and then add them to the <property name="features"> , but the problem is that all the services return the same swagger.json and that is the one that comes first in the Alphabet order. so i searched the internet and some developers said that i should add <property name="usePathBasedConfig" value="true" /> to each child bean. and when i did that all the services now just return this swagger.json file. { "swagger": "2.0" } Any Suggestions please.
How to add Authorization Header to a Rest Request in Java
Hi, I am trying to upgrade swagger-ui from 2.0 to 3.21.0. In 2.0 I used to get the user name along with base url by making the change in index.html.After that setting the user inheader of each request. The same thing I would like to do in Swagger-ui 3.21.0. Can Some one please help in this? Expected:1.how to edit index.html codeto get the one more input from GUI. 2.After getting the input how to set value in header.
