Questions tagged [springfox]

The Springfox suite of java libraries is all about automating the generation of machine and human readable specifications for JSON APIs written using the spring family of projects.

The Springfox suite of java libraries is all about automating the generation of machine and human readable specifications for JSON APIs written using the spring family of projects. Springfox works by examining an application, once, at runtime to infer API semantics based on spring configurations, class structure and various compile-time java annotations.

Useful links

794 questions
0
votes
1 answer

Manually describing Swagger input/output models (without Java domain class)

We have an existing REST API build with Spring MVC. We are now spiking to see if we can use Swagger to generate internal documentation (quickly). The problem with our REST implementation is that we do use Spring MVC to convert business objects to…
Marcel Overdijk
  • 11,041
  • 17
  • 71
  • 110
0
votes
1 answer

Change the parameters in body request of a method in Swagger

I've been working on a project and try to document it using Swagger-2.0. In this project due to some security issues, every method in controllers that has an object as a return type should change the return object to a completely flat object. In…
moha
  • 579
  • 2
  • 9
  • 27
0
votes
1 answer

How to avoid general Swagger Warnings?

i am going to validate my swagger (v2) documentation in http://editor.swagger.io/#/ but i got follow warning message. { "generalSwaggerWarnings": [ { "swaggerObject":…
ERK
  • 344
  • 6
  • 27
0
votes
1 answer

Unable to integrate Factory Pattern along with Spring-Swagger

I have implemented factory pattern using ServiceLocatorFactoryBean by following this reference. It is working fine. I am using swagger-springMVC (SpringFox), It is also working fine. But, when I am trying to use factory pattern along with swagger…
kumar
  • 481
  • 3
  • 7
  • 18
0
votes
1 answer

Rest Api documentation with swagger and Spring MVC

Hi' I have several REST api in my spring mvc project and I would like to create documentation for each service and store it in file so I can share with the team. I often read about Swagger or Springfox and configure it so, I added
luca
  • 3,248
  • 10
  • 66
  • 145
0
votes
1 answer

Custom json with Swagger

I'm using Spring boot with Swagger 2(using springfox to wrapper). I have a big entity that a lot of fields is filled automatic at server side and I have a service to store them. Instead of swagger show all the attributes of this entity like this I…
Gustavo Lira
  • 391
  • 5
  • 19
0
votes
1 answer

Springfox not generating Swagger docs correctly for same operation-endpoint, different query parameters

Springfox doesn't generate correctly the swagger doc for a simple case like this one: GET /api/departments - Gets all department GET /api/departments?name=IT - Gets a department with name passed as query parameter This is the Spring…
codependent
  • 23,193
  • 31
  • 166
  • 308
0
votes
1 answer

Swagger Version for Spring 3 and Spring 4

I want to documenting a REST API with Swagger and Spring MVC, And I find out that Spring 3 only can use Swagger V1 swagger-springmvc 1.0.2 when I add @ApiParam in front of @RequestBody ,…
Giambi Huang
  • 111
  • 1
  • 13
0
votes
1 answer

springfox does not return the api doc

I'm trying to integrate springfox in to my existing sprint web application I configured the springfox the web app is starting correctly but the api doc is not getting generated here is the springfox configuration class @EnableSwagger2 //Loads the…
madu
  • 344
  • 3
  • 14
-1
votes
1 answer

With spring fox version 2.9.2 Im not able to access swagger

"Correct the classpath of your application so that it contains a single, compatible version of springfox.documentation.builders.RequestHandlerSelectors"
-1
votes
2 answers

Spring Fox (Swagger) 2.9.2's Autogenerated swagger-ui is Not Showing Interactive API

Using Spring Fox 2.9.2 with Spring Boot 2.1.5 RELEASE, I am not able to use the interactive UI generated by Swagger. This is with the REST Endpoints not expanded: This is with the REST Endpoint expanded (as you can see there's no text field to…
PacificNW_Lover
  • 4,746
  • 31
  • 90
  • 144
-1
votes
1 answer

Add a custom header to OAuth2 authentication in Springfox Swagger

I'm trying to add a custom header to the OAuth Security Scheme (Springfox Swagger 2.8.0). Any ideas how this could be achieved? My current configuration (using OAuth with ImplicitGrant, server side is keycloak) looks like: @Bean public…
hakamairi
  • 4,464
  • 4
  • 30
  • 53
-1
votes
1 answer

Use of "reference" element in @ApiResponse annotation in swagger to refer response samples

I need to show the response example value with respect to each code in Swagger UI, I'm using Spring Boot + springfox-swagger2
-3
votes
1 answer

What is the springfox in the pom dependency?

what is the springfox. i saw in the pom.xml properties. but i can't understand the springfox. io.springfox springfox-swagger2
Moon Taejin
  • 351
  • 3
  • 9
  • 21
1 2 3
52
53