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

Swagger you don't send parameters in Get method in spring mvc?

I have spring mvc controller that have a method. This method get some parameter. I configure swagger and using swagger for test a request.When I want to try request parameter it does not send. @RequestMapping(value = "/listGrid", method =…
ali akbar azizkhani
  • 2,213
  • 5
  • 31
  • 48
0
votes
0 answers

Enum in swagger-ui

The model schema is not appearing for the response. The json is "200":{ "description":"OK", "schema":{ "type":"string", "enum":[ "SUCCESS", "FAILED" ] } } but nothing…
Danny Bentley
  • 60
  • 2
  • 9
0
votes
1 answer

Object json creation with springfox

I have a class documentKey which when rendered through springfox outputs Inline Model [ DocumentKey ] DocumentKey { _id (string, optional), _rev (integer, optional), _type (string, optional) } which is…
Danny Bentley
  • 60
  • 2
  • 9
0
votes
1 answer

SpringFox swagger-ui integration

My output generated in the swagger-ui is: DocumentChangeSet { deletes (Collection«DocumentKey», optional), updates (Collection«AbstractDocument», optional) } Collection«DocumentKey» {} Collection«AbstractDocument» {} Is there any way to make it go…
Danny Bentley
  • 60
  • 2
  • 9
0
votes
1 answer

Use of byte[] with spring-rest and springfox

I am new to REST API design and I have two questions about the API I am trying to write. I want to create a service that, giving a PDF file encoding, creates an object in the database. My current service looks like this: @RequestMapping(value =…
ferjani
  • 89
  • 8
0
votes
0 answers

Springfox / Swagger not picking up annotations from library

I have springfox integrated with my spring-boot application and the /swagger-ui.html is displaying my REST endpoint documentation successfully. However, my project is structured so that the API model classes are in another project (referenced in…
0
votes
1 answer

Swagger Dependencies break Spring Boot application

I am working on a simple Spring boot application. The exposes a single point to retrieve application version. The application runs fine when deployed on a Tomcat server and when run as a spring Boot application. My problem is when I add Swagger…
Maro
  • 4,065
  • 7
  • 33
  • 34
0
votes
1 answer

How to use springfox in a less invasive way?

I want to use springfox to generate API docs in a springmvc project. But by using springfox, I must add java annotation to controllers and models, which is very invasive. So what can I do to use it in a less invasive way? Or what else frameworks can…
Shildon
  • 11
  • 5
0
votes
1 answer

Swagger - IncludePatterns option not availbel in docket

I am trying to disable swagger in specific environment and I am able to do it by doing a .enable(false) in docket but the UI page still loads SWagger ui frame and displays null on the page. I would like to completely get rid of it but the include…
Fancy
  • 11
  • 1
  • 4
0
votes
1 answer

Which classes are scanned during the Swagger auto-configuration process?

In the Swagger docs I read that the @SwaggerDefinition annotation can be placed in any of the classes that are scanned during the Swagger auto-configuration process. I put the annotation in my controller class inside the controller package, and I…
Akshay Damle
  • 1,220
  • 3
  • 18
  • 31
0
votes
1 answer

Swagger2 springboot springfox cannot rename api

I tried to use @Api and @ApiModel to rename my api reference but nothing seems to work. It always takes the class name. Im using swagger2 + springfox 2.4 + springboot.
Ronny Shibley
  • 2,030
  • 22
  • 25
0
votes
2 answers

Springboot + springfox + swagger2 + swagger-ui

How can i access the generated swagger-ui.html ? Or index.html I cant seem to find this file in my project. Aghhhh!
Ronny Shibley
  • 2,030
  • 22
  • 25
0
votes
1 answer

Swagger UI not working Rest APi

I have a Rest Api project and I am trying to use swagger to documentation and UI. I was able to get the documentation but UI is not seeing api documentation and pulls up blank. I have copied contents of dist folder under webapps/WEB-INF I can access…
Ani
  • 598
  • 5
  • 13
  • 29
0
votes
1 answer

ID Should Not Show Up for Model Schema with Swagger + Spring

I'm using Swagger2 with Springfox and Spring Boot. I have an endpoint defined like so: @ApiOperation(value = "save", nickname = "Save Store") @ApiResponses(value = { @ApiResponse(code = 201, message = "Created"), @ApiResponse(code =…
Gregg
  • 34,973
  • 19
  • 109
  • 214
0
votes
1 answer

Swagger Java class is not parsing properly

I am using swagger to create API documentation for one of my Spring Rest API project, but the swagger.json file created is having an issue. One of my Super class is not getting converted properly. Library used to implement the swagger is springfox.…
Vivek
  • 1
  • 2
1 2 3
52
53