Navigation Menu

Skip to content

Releases: springfox/springfox

3.0.0

14 Jul 03:19
@dilipkrish dilipkrish
3.0.0
bc9d0ca
Compare
Choose a tag to compare
3.0.0 Latest
Latest

Release Notes

image
Picture Credit National Geographic

First and foremost a big thank you to the community for keeping me motivated to work on this project. There have been some really amazing contributions in this release in terms of code, comments, bug reports and it is humbling to see people jumping in to solve problems on the issue forum. It sure motivated me to get over the "hump" and start working on in earnest. What better way to lose the COVID blues!

Thank you! 🥳 🍾

Also please welcome the newest maintainer to the springfox team @MaksimOrlov. A lot of the great work you see in the model generation support is due to his efforts, collaborating tirelessly on weekends and not giving up while ensuring the model generation engine is performant 👏

NOTE: This is a breaking change release, I've tried to maintain backwards compatibility with earlier versions of springfox as much as possible. Deprecated APIs prior to 2.9 have been aggressively removed and new APIs that will go away in the near future have been marked. So please look out for those and do report anything that has been missed.

Highlights of this release include

  • Spring 5, Webflux support (only request mapping support, functional endpoints aren't supported yet)
  • Spring Integration support (feedback is much appreciated)
  • Spring Boot support springfox-boot-starter dependency (Zero Config, Autoconfiguration support)
  • Documented Configuration Properties with autocomplete
  • Better specification compatibility with 2.0
  • Support for OpenApi 3.0.3
  • Zero Dependency (almost, the only libraries needed are spring-plugin, pswagger-core](https://github.com/swagger-api/swagger-core)
  • Existing swagger2 annotations will continue to work and enrich open api 3.0 specification

Compatibility Notes

  • Requires Java 8
  • Requires Spring 5.x (not tested with earlier versions
  • Requires SpringBoot 2.2+ (not tested with earlier versions)

Contributions

Significant contributions that come to mind (and please remind me of others in this list cos' my memory is weak)

  • @MaksimOrlov for his work on better model generation (json view, validation groups, request/response models)
  • @dschulten for introducing spring integration support
  • @deblockt and @ligasgr for their work on webflux support
  • @ile for spring 5 support
  • @neil1hart for removing the guava dependencies
  • and @cbornet for the occasional nudges to working on this release :)

Pull Requests

Bug Fixes

  • Parameter 0 of constructor in springfox.documentation.spring.data.rest.EntityServicesProvider required a bean of type 'javax.servlet.ServletContext' that could not be found. (#3382) by @desiderati
  • Model property order is no longer respected as of 2.9.2 (#3087) by @dilipkrish
  • Base URL is wrong with 3.0.0.SNAPSHOT waiting-for-more-info (#3030) by @ogerardin
  • Example property on operations does not work (#2767) by @dilipkrish
  • JsonView Is not working as expected (#3373) by @dilipkrish
  • Provide intelligent defaults for web flux types Mono and Flux maintenance (#3354) by @dilipkrish
  • How to detect Spring MultipartFile paramter in ApiModel annotated POJOs and show file upload button in Swagger-UI (#1370) by @roseoxhu
  • Unable to infer base url... springfox-swagger2 version 2.9.2 (#3001) by @lombocska
  • swagger-ui.min.js and jquery1.8.0.min.js fail to load on AWS Lambda using Sprint Boot 2 (#3289) by @thomashoef
  • ApiInfo in Docket will not contain old value if parameter is null. (#3314) by @Snap252
  • Response Model with Map can not be showed the details in response (#3297) by @dianfenzhan
  • 502 bad gateway when deploying to AWS, works locally. (#3300) by @AliZarrouk
  • Swagger UI is not showing fileupload button for RequestBody of type Byte Array (#3364) by @lakshmitharun
  • Missing "content-type" header during POST request and missing properties in swagger-ui screen (#3353) by @gwcakep
  • springfox-swagger2:3.0.0-SNAPSHOT Generates conflict of the beans 'requestMappingHandlerAdapter (#3342) by @josuemojena
  • Infinity loop when starting spring boot server (#2907) by @Tandolf
  • springfox-swagger 3.0.0 - SNAPSHOT - JSON schema not being generated as it was before te update (#3343) by @pmroch
  • Missing #ref in JSON when using Map<String,Map<String,List>> as a response type. (#3356) by @vpm911
  • Swagger UI is not able to submit form data with file attachment & JSON parameter (#3311) by @mobasherswl
  • NPE on EnumMapper.maybeAddAllowableValuesToParameter(EnumMapper.java:117) (#3339) by @othellico
  • In 3.0.0-SNAPSHOT, using the ModelAndView parameter, an error log appears. (#3380) by @wangxin
  • ResponseHeader is not working as expected (#3374) by @dilipkrish
  • ResponseHeader annotation not parsed? (#2684) by @watery
  • Swagger does not respect Jackson @JsonIgnoreProperties annotation (#2613) by @guan25
  • @ExampleProperty/value is getting ignored (#3037) by @napolev
  • Unable to scan documentation context default java.lang.NullPointerException: null (#3303) by @WesleyBlancoYuan
  • Oauth 2.0 redirect_uri params is not an absolute URL using 3.0.0-SNAPSHOT (#3368) by @Tqup3
  • Swagger-ui is incorrectly using a base path when you "Try Out" the api (#3351) by @dilipkrish
  • SecurityContext#securityForOperation unespected behaviour if using only operationSelector (#3361) by @Aitor1405
  • springfox-swagger2:3.0.0-SNAPSHOT Access denied to: springfox-swagger2-3.0.0-20200629.123820-84.jar (#3357) by @kentilini
  • swagger-2.9.1 /csrf is 404 (#2603) by @hxiugangxh
  • Unable to find a model that matches key in 3.0-SNAPSHOT and Spring WebFlux (#3348) by @mdsina
  • AllowableValues for @ApiParam is not honored by Swagger when request parameter is Collection Array (#3321) by @SarveshSharma06
  • Docket.apiInfo never reverts to default (#3327) by @jensgram
  • Spring fox not accepting size parameter for uuid (#3329) by @manya0810
  • When using javax.validation.constraints annotation on method parameters，the parameter is recognized as the request body (#3338) by @zx472010602
  • When @enable...
Read more
Assets 2

2.9.2 Release

24 Jun 05:05
@dilipkrish dilipkrish
2.9.2
09d4a73
Compare
Choose a tag to compare
2.9.2 Release

2.9.2 Release

JUDITH VRUGT, NATIONAL GEOGRAPHIC YOUR SHOT
© JUDITH VRUGT, NATIONAL GEOGRAPHIC YOUR SHOT

Thank you for the patience with this release. More importantly, thank you for your contributions in helping identify bugs and issues and improving the library with your contributions!

Pull requests and contributions

Bugs

  • (#2502) OperationContext only finds SecurityContext's by path ignoring methods
    @robinsonmark
  • (#2481) ConditionalOnWebApplication not found after upgrading to 2.9.0 duplicate @gionn
  • (#2461) 2.8.0 /swagger-resource/configuration/ui does not set Accept header properly @OverDrone
  • (#2446) ApiParam allowableValues string with spaces is not supported @uriparush
  • (#2438) Upgrade to SpringFox 2.9.0 causes failures in Spring Boot 2.0.2.RELEASE @james
  • (#2428) description = "@SiZe: Min - Max (until #1244 gets fixed)" when param annotated with @min and/or @max but #1244 is already fixed @haelduksf
  • (#2423) Query Parameter extracted from Object doesn't recognize public field without getter @kintomiko
  • (#2415) JSR-303: Size annotation on Path Param generates maximum/minimum, but on Model generates maxLength/minLength @retinaburn
  • (#2401) Present multipart object attributes as "formData" duplicate @andyRokit
  • (#2376) Model attribute expansion should respect form/query parameter type
    @dilipkrish
  • (#2498) Path Parameter generated having unsupported properties duplicate @FossilBlade
  • (#2481) ConditionalOnWebApplication not found after upgrading to 2.9.0 duplicate @gionn
  • (#2466) There is no jar in maven repo.Why? duplicate @litttlefisher
  • (#2441) Upgrading from 2.8.0 to 2.9.0 causes SpringBootTest to stop working duplicate @maraswrona
  • (#2401) Present multipart object attributes as "formData" duplicate @andyRokit
  • (#755) o.s.data.domain.Pageable - automatically add @ApiImplicitParams? can-use-for-docs duplicate @Steve

Feature

  • (#2180) Is it possible to document OAuth 2 scopes for different HTTP methods? feature @Beontra
Assets 2

2.9.0 Release

25 Apr 04:46
@dilipkrish dilipkrish
2.9.0
2fab174
Compare
Choose a tag to compare
2.9.0 Release

test
©️Photograph by Alex Geifman courtesy National Geographic

2.9.0 Release

This is the last release supporting jdk 7 and spring 4.x. The next planned release is 3.0 which will have jdk 8 as a pre-requisite. There was a large effort to ensure a stable release before moving to the next major release. A big thank you again for the numerous feature/bug requests for making this product better and supporting this library.

A special thank you to @kasecato, @MaksimOrlov, @neumaennl, @rgoers and @Fyro-Ing for working on some much requested features.

NOTE: All deprecations will be removed when we move to 3.0

NOTE: This release isnt available via maven central due to issues publishing to maven central. Still working through the issues. It is available via jcenter.

Pull Requests

Features

  • (#2361) Make Documentation Plugins Bootstrapper autostart configurable feature @dilipkrish
  • (#2293) Added Vendor Extensions Support to Tag object feature help wanted @nhtzr
  • (#2253) Producing "x-example" with @ApiParam for @PathVariable feature help wanted @kilsbo
  • (#2166) Swagger UI 3.x Suggested Improvements feature help wanted @dilipkrish
  • (#2125) I want to Example Value customize feature help wanted @cheese10yun
  • (#1903) XmlAttribute not applied duplicate feature @janfockaert
  • (#1151) Add Polymorphism Support feature @Fyro
  • (#868) Springfox support for polymorphism duplicate feature help wanted @sunaina
  • (#2043) Generate own model @deblockt
  • (#1700) @ApiModelProperty add example will be parsed to json duplicate @igieon
  • (#1232) Externalizing Descriptions of Api-Annotations (ApiModel/ApiModelProperty/...) @jfiala
  • (#1449) @ApiModelProperty not displaying attribute when using @ModelAttributeode duplicate @rantunesboreas

Bugs

  • (#2039) Endpoints with the same path and parameters but different headers some times cause java.lang.IllegalArgumentException: Multiple entries with same key @joaoacmota
  • (#2194) Swagger-UI authorization headers stopped being sent in 2.8.0 @ctmay4
  • (#1964) How to disable 'example' output in models for booleans @fairct
  • (#2127) Endpoints not exported with Spring Data REST has-workaround @drenda
  • (#1827) Error when rendering recursively defined models @tcsw1221
  • (#2230) @XMLRootElement and @XmlAttribute ignored @rstmm
  • (#2265) @ApiModelProperty throwing NumberFormatException if example value is not set wontfix @nikunjundhad
  • (#2204) Schema error: should NOT have additional properties allowEmptyValue @igorko
  • (#2203) Nested maps are not being converted properly to Swagger models @francocm
  • (#1937) @ModelAttribute with getters and no setters @bademux
  • (#2357) swagger-ui.html in 2.8.0 contains references to 2.8.0-SNAPSHOT @nahguam
  • (#1831) @ApiParam hidden=true does not work on @RequestHeader help wanted @scottf
  • (#2231) Cannot create a rule to substitute list items with primitive types @mclem
  • (#2182) JsonUnwrapped prefix ignored in release 2.7.0 @ccdd4ever
  • (#2314) UUID parameters don't have format "uuid" @dominik
  • (#2249) How to avoid the automatic number convertion for example @thelo
  • (#2368) Void type in @ModelAttribute annotated classes. @MaksimOrlov
  • (#1944) @ApiResponse(... response = Void.class) produces empty model, (... response = void.class) does not has-workaround @rtomsick
  • (#2076) How to convert a model Property to an Attribute in XML based req/res spring boot application? @vinodamity
  • (#2226) JAXB is required as explicit dependency for kotlin service/ @flatiron32
  • (#2257) Tests fail on windows @atsu85
  • (#2272) springfox-data-rest v3 support duplicate @PascalSchumacher
  • (#2311) springfox-data-rest: Inconsistent model returned between findAll and search methods @Iles
  • (#2322) NumberFormatException when parsing node name from Forward header with double quotes not-reproducable @thiagolocatelli
  • (#2216) Springfox Swagger UI [2.8] IE / Edge Support @gerard
  • (#2278) Swagger UI 2.8.0 doesn't show response working with ApiOperation can-use-for-docs @mhersc1
  • (#2320) SpringFox 2.8.0 Error: "Could not resolve pointer: /definitions/String" @mrgrew
  • (#2212) SizeAnnotationPlugin spams log at INFO level @shabino
  • (#2220) OperationParameterReader does not process optional path parameters correctly @raphw
  • (#2235) Full URLs in /swagger-resources no longer works after 2.7.0 -> 2.8.0 Upgrade @gloeglm
  • (#2263) @RequestPart "name/value" attribute ignored @fschmager
  • (#2268) Optional query parameters are marked as required in the UI not-reproducable @ok11
  • (#2271) When there are two return bodies with the same name class, only one class parameter can be parsed normally. For example: two Data classes duplicate @k631583871
  • (#2282) java.lang.StackOverflowError happened when model extends genericity class @seven4x
  • (#2283) IE11 browsers can't display page on version 2.8.0 duplicate @903452746
  • (#2296) @RequestParam field with default value "" (empty string) is marked required duplicate @mumi
  • (#2298) Support for breaking spring-data-rest changes java.lang.NoSuchMethodError duplicate @salah3x
  • (#2309) Swagger-ui web jar is not producing the artifact correctly @dilipkrish
  • (#2315) Swagger 2.8.0 not working on IE11 duplicate @Snina88
  • (#2316) @RequestPart not reporting type or allowableValues in generated API not-reproducable @bgiaccio
  • (#2347) Parameter Vendor Extensions doesn't show up in generated spec @RisenZhong
  • (#2276) @RequestParam with defaultValue of empty string on String parameter marked as required @matthewmcgarvey
  • (#2286) [XmlPropertyPlugin]: Optional.get() cannot be called on an absent value @bratwurzt
  • (#2370) Not able to disable schema validation. @makcpop
  • (#1909) springfox doesn't work with Jackson 2.9.0.pr4 beihaifeiwu
  • (#2344) When i use Swagger Junit is not working not working @pparnati
  • (#2365) The json serialiser ignores the dataType when output the digits only string @ouya2

Maintenance

  • (#2350) Upgrade libraries @dilipkrish
  • (#2329) Activate springfox only when web environment is available @dilipkrish
  • (#2264) Upgrading swagger-ui to 3.11.0 PR @kasecato
  • (#2256) Docket SecurityContexts to filter by HTTP methods @vadimkim
  • (#2252) Suggestion about PojoPropertyBuilderFactory: Change the alerts about Jackson 2.6 compliance @rs
  • (#2243) Remove dependency on org.reflections.Reflections @leewinder
  • (#2228) Added minify plugin PR @kasecato
  • (#2219) ApiListingScannerPlugin is ignored if no Spring controller is registered @raphw
  • (#2137) From swagger editor able to get the JWT auth token, but from application which enabled swagger-ui using springfox is not working @ranjithap7576
  • (#1980) spring-data-rest RepositoryRestResource.collectionResourceRel not Mapped in Model @n3utrino
  • (#1973) Springfox Swagger configuration breaks customized ObjectMapper in Spring Boot has-workaround @avillev
  • (#1680) HAL Resources not rendered correctly duplicate @raffaelschmid
  • (#1657) Parameter vendor extension support @zidanluo
Assets 2

2.8.0 Release

14 Jan 23:11
@dilipkrish dilipkrish
2.8.0
b37d9c0
Compare
Choose a tag to compare
2.8.0 Release

fqysubvfts-t7odkrfjckdifehvab0gwofzhj7tydc0uglagsdnfmzfsja1ureau0bk_nhohzaxypli0omwuxrdklzhbyy7fr9bei21ciclo01ztnfl9v9bpbbswgk-tneeak0kr990thliabpsimd8wpkncfvwmesnakphpa9hredbcmnnmzeok-ulizut9elguzgu5usuo04jxp7sitnsbq7vovg
Photograph by Margaret Krzepkowski

Thank you everyone for your contributions.

While this release still doesnt support OpenAPI 1.0 spec, it does bring support for the new swagger-ui look thanks to @kasecato!! 🙇

Apologies for the delayed release schedule of 2.8.0. Much of the work in this release was to shore up the library for significant work in the near future to support in 2.9.0

  • OpenAPI spec 3.0
  • Set the stage for fixing bugs related to Swagger 1.2 Spec. This is the penultimate release with support for swagger1

2.9.0 will be the last supported release for Java 6/Java 7. Much of 2.9.0 will focus on Improvements in the model rendering thanks to @MaksimOrlov! 🙇 (support @JSONVIEW, better support for rendering the same models in request/response, inheritance support). Please note the deprecation warnings to prepare for breaking changes in 3.0.0.

Pull Requests

(#2178) Change regex in Paths.java to handle expressions/constraints correctly @nobe0716
(#2174) fix fmt maintenanc @silenceshell
(#2169) Swagger ui 3.x suggested improvements feature @kasecato
(#2160) Fix conversion of byte to integer with max / min bug @avdv
(#2153) Upgrading Swagger UI to 3.7.0 @kasecato
(#2144) Allow ApiModelProperties on methods to be discovered from superclasses @RoyJacobs
(#2106) Add support for exclusive ranges handling @filiphr
(#2103) Fix some tests under windows @apixandru
(#2101) Fix Remapping issue @apixandru
(#2081) Fix child expansion context creation bug @gzsombor
(#2069) Optimise HandlerMethodResolver.getMemberMethods maintenance @simongajdosech
(#2066) Added error handling around "duplicate" request handlers @mate1983
(#2048) Support explicit ordering for Tags @jroweboy
(#2040) Use Guava 20.0 throughout the project maintenance @Thunderforge
(#2014) Fix markdown @koppor
(#2013) Fixed merging headers from the already existing request with the supplied request @pvanassen
(#1988) custom the web page title as swagger.title when had set it @rainplus
(#1974) Add default property support on model properties feature @matrosovs
(#1956) @ApiModelProperty example string does not escape char "" from JSON example @heapifyman
(#1952) Fix to recognize @param as query parameter in EntitySearchExtractor know @viruscamp
(#1943) Wrong API resource path in Swagger 1.2 @mathieuales
(#1942) Model classes having names containing integers are not detected as array @mathieuales
(#1917) Consumes / Produces media-types on the document level aren't copied and merged anymore with the operation level consumes / produces media-types. @mzeijen
(#1914) Provide proprty pattern annotation support @simonamc
(#1897) Correct spelling and typos @naXa777
(#1878) Preserve tags order in documentation builder @rainoko
(#1868) Create EntitySaveExtractor.java @jadhavsuhas
(#1838) Fix a mixed up part in the Getting Started guide for Docket @PeterWippermann
(#1837) Minor update of Docket's JavaDoc @PeterWippermann
(#1829) JacksonEnumDeterminer to handle JsonFormat.Shape.Object @yelhouti

Features

(#2177) Paths.sanitizeRequestMappingPattern fix @nobe0716
(#2139) Should support "title" property, set via @apimodel annotation. @ngbalk
(#2088) @ApiParam(allowableValues = "range(0, infinity)") does not work @filiphr
(#2063) Added support for Pageable resolved parameter @avillev
(#2057) Swagger-ui don't render additionalProperties duplicate @deblockt
(#2026) Produces/Consumes do not maintain order @jgaribay21
(#2023) Is it possible to disable globalResponseMessage configuration partially. duplicate @DoHoon
(#2021) @ApiModelProperty.allowEmptyValue = true/false does not emit "allowEmptyValue" in swagger.json @Bill
(#2000) Upgrade to latest version of Swagger UI (3.1.5) duplicate @madheshr
(#1960) Upgrade to swagger-ui 3.0 duplicate @alex
(#1957) springfox doesn't work with spring boot 2.0 and spring data Kay-RC2 duplicate @shashankitmaster
(#1955) Add support for inclusive and exclusive ranges for allowable values @JohnNiang
(#1946) collectionFormat problem @vitek499
(#1936) configuration for adding dynamic api-key(access token value). duplicate @akashgupta08
(#1919) Add support to rename ApiModel property name in Model Attributes @peterjurkovic
(#1901) Pattern Bean Validations API (JSR-303) support for Request Parameters help wanted @simonamc
(#1900) Tag custom ordering @rainoko
(#1818) JsonFormat for enum and other cases @yelhouti
(#1729) Status of support for v3.0.2 of Swagger UI duplicate @JLLeitschuh

Maintenance

(#2161) How to set a default value to a field of a model? in progress @michele
(#2093) swagger-ui.html appears to be empty documentation @silentsnooc
(#2090) When using AlternateTypeRuleConvention ApiModelProperty annotation does not work @snimavat
(#2031) How to get object in response body in autogenerated swagger.json file documentation @rajat
(#2029) ApiImplicitParam with empty datatype fails when we try it out documentation @ljp510016132
(#1995) View APIs from different Spring Cloud Instances registered in Eureka documentation @s
(#1971) Vavr/Javaslang Jackson module support documentation @sir4ur0n
(#1954) Multiple swagger JSON's in swagger-ui.html documentation @dreambrother
(#1950) Document support customized param using HandlerMethodArgumentResolver documentation @neil4dong
(#1916) Consumes and produces media-types defined on Docket are incorrectly merged together with consumes/produces media-types that are defined on a resource level @mzeijen
(#1913) Space getting added to oAuth scope while making authorization request documentation @mojaiq
(#1904) Nondeterministic output for Models used in multiple controllers documentation @kevinm416
(#1899) Upgrade libraries @dilipkrish
(#1896) Wrong spelling and typos in code @naXa777
(#1882) @RepositoryRestResource -- ApiParam definition for the JPA methods always defines the @param as "body" type parameter @aniruthmp
(#1875) Tags should be orderable @rainoko
(#1870) The lasted version supported for Swagger UI 3.x? @maliqiang
(#1865) Can't test the configuration 404 not found documentation @pinkyjain26
(#1833) Different guava versions in dependencies @Dimok74
(#1704) Document springfox oauth2 documentation duplicate @kidshg

Bugs

(#2165) AlternateTypeRules doesn't work as expected @crmky
(#2148) 2.7.1-SNAPSHOT NullPointerException when attempting to view http://localhost:8080/v2/api-docs @beardy247
(#2138) java.util.Optional<java.time.OffsetDateTime> disappears from request params duplicate @bohdan
(#2135) No qualifying bean error when launching spring 5.0.x application with springfox duplicate @gauravphoenix
(#2133) Optional @kitsjory
(#2132) @ApiModelProperty has no effect on some variables (name starting with one lowercase) not-reproducable @bbrenne
(#2118) Request type mapping doesn't work if using both RequestBody and ModelAttribute on the same parameter @Andrea
(#2114) @RequestParam and @PathVariable annotated parameters should not be expanded @loxal
(#2111) Application startup failed org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'documentationPluginsBootstrapper' @shobhit921
(#2107) @ApiParam ignores certain properties duplicate @milosonator
(#2097) Swagger 2 : Getting "type": "ref" when using @RequestPart duplicate @jrishabh198
(#2096) @ApiParam is ignored on ValueObjects wrapped with @JsonCreator @dkellenb
(#2080) NullPointerException in handlerPackage duplicate @ejuniorasas
(#2072) Springfox generates Api-Doc for non-exported Repositories @stoetti
(#2053) @PathVariable work with Parameter Converter strangely duplicate @cxl086
(#2039) Endpoints with the same path and parameters but different headers some times cause java.lang.IllegalArgumentException: Multiple entries with same key @joaoacmota
(#2025) SpringFox-Data-Rest 2.7.0: Missing camelCase with generated Associations operationIds @stoetti
(#2015) Add support for generics not-reproducable wontfix @raderio
(#2012) Duplicated swagger.json document not-reproducable @cesartl
(#2011) OperationBuilder mergeResponseMessages overwrites headers @pvanassen
(#1999) Generated JSON for endpoints with PathVariables converted to non-trivial objects is incorrect duplicate @joel
(#1998) PathVarible composed of Custom Objects are not parsed correctly duplicate @frbo42
(#1965) @RequestPart annotation not rendering models correctly @pratapyelugula
(#1963) Spring Data Rest Integration doesn't document repository method parameters correctly @thombergs
(#1961) Springfox - Authorization value didn't update after Authorize confirmed.. @thomasharin
(#1941) swagger-ui does not remove java string escape char "" from @ApiModelProperty example @heapifyman
(#1932) BasePathAwareController docs aren't base path aware @fquinner
(#1926) Can't be filtered by ignoredParameterTypes not-reproducable @heyuxian
(#1924) Unable to define host in Swagger 1.2 @mathieuales
(#1906) Swagger shows wrong id field using Spring Data Rest duplicate @drenda
(#1894) @EnableSwagger2 breaking my unit tests not-reproducable @rawadrifai
(#1890) Can't declare Docket in multiple Configuration classes not-reproducable @lorenzobenvenuti
(#1887) @ApiResponses tag does not override default responses not-reproducable @muff1nman
(#1880) Wrong API resource path in Swagger 1.2 @mathieuales
(#1876) Nu...

Read more
Assets 2

2.7.0 Release

21 May 03:25
@dilipkrish dilipkrish
2.7.0
92814f1
Compare
Choose a tag to compare
2.7.0 Release

springfox-270
Photo credit Mark Summers via National Geographic

Thank you for being patient with this release. This is packed with bug fixes (over 40 of them) and over 15 new features.

Many thanks to those contributing with feature requests, questions, bug reports and most importantly helping out with pull requests. With time being such a premium, its getting harder and harder to address without the contributions of the many listed below.

Significant changes in this release

  • This includes a re-write of the spring-data-rest support
  • Preparation for removing deprecations that will be removed support 3.0 of Open API spec. Also this release is no longer verified as compatible with spring 3.x. Also it requires spring 4.2.x and greater
  • Libraries have been upgraded especially jackson to 2.8.x and guava to 18.0

PRs (Thank you 🙇)

#1806 Update PropertySourcedRequestMappingHandlerMapping.java @OzgaRobert
#1793 [#1770] Remove the requirement for property sources placeholder @dilipkrish
#1782 Model property vendor extension @philippejulien
#1776 Fix Swagger version error in documentation @ersinciftci
#1761 Vendor Extensions for API Info and Documentation @jkgentry
#1758 Use double backtick to prevent miss parsing @naxhh
#1741 1740 @JsonUnwrapped is ignored by schema generation test @StepanLeybo
#1730 Fix a typo at the common-problems documentation file @florianrusch
#1717 Adding vendorExtensions in apiKey class @cfernandezh
#1702 Make ApiResourceController methods public @psyho
#1699 Make Swagger2Controller respect basePath even if a host is not set @asdcdow
#1693 Fix for #1653 @pjskyboy
#1667 #1666 allowableValues blank for Optional parameter @madgnome
#1660 waffle.io Badge maintenance @Waffle
#1617 Updated swagger-ui version to 2.2.8 @acourtiol
#1593 OAuth2 not initialized when clientSecret undefined @gonzalad
#1589 Apply ApiParam hidden attribute to parameters @defshine
#1576 Added support for composed bean validation constraints @jamesbassett
#1371 JSR-303 for Request parameters, Fix Allowable values not displayed in Apidocs, Externalizing Api Descriptions @jfiala

Features

#1759 Support for property vendor extensions @philippejulien
#1707 Removal of "swagger-ui.html" from uri path causes swagger-ui JavaScript error @LukeHackett
#1636 VendorExtension support in ApiKey @mlstocks
#1627 Error with group handling response @marchc
#1592 OAuth2 clientSecret shouldn't be required for implicit flow @gonzalad
#1590 springfox-data-rest : Pageable not supported duplicate @tooms4444
#1544 [Feature request] JDK8 JSR310 types support @cbornet
#1497 springfox-staticdocs : Update to last swagger2markup version @orevial
#1490 Infer alternate type rules using serializers and deserializers @justcoon
#1423 @RequestParam with placeholders syntax like ${x.y} @blelem
#1413 Ability to set VendorExtensions on ApiInfo? @michael-pratt
#1367 Springfox overwrites swagger path entries with the same base path but with different content types @codecounselor
#1299 Feature Request: Upgrade swagger2markup version to v1.0.0 duplicate @fayndee
#1227 Bean Validations API (JSR-303) support for Request Parameters @jfiala
#1169 Add Support For Documenting Services In Grails Projects @dilipkrish
#1008 Models with different packages are not represented uniquely in the generated swagger document @tenstriker
#824 Support vendor extensions in operations @cbornet
#1736 Spring-Data-Rest support for property references

Maintenance

#1701 Make ApiResourceController methods public @psyho
#1694 Fixed the intermittent build failures @dilipkrish
#1675 Why generic method names are being generated for Spring Data Rest? @tahir
#1653 springfox-data-rest: 2.6.1 spring-data-rest: 2.6 RepositoryRestHandlerMapping constructor broken @cbbs
#1644 Update library to support for Spring 5 @binkley
#1628 swagger-ui 2.2.10 @IanSwift
#1621 2.6.1 breaks @value placeholder replacement @2is10
#1505 Release process fails when updating the documentation @dilipkrish

Bugs

#1797 How to write a custom ApiListingScannerPlugin? @indrabasak
#1786 StackOverflowError In 2.6.1 @tcsw1221
#1785 @ApiOperation "response" value causing docs to ignore model annotations @bfinleyui
#1780 ConcurrentModificationException on startup with -20170420.041823-43 @gionn
#1778 javax @Valid annotation makes parameter as requestbody-parameter @jmattheis
#1775 Swagger version error in documentation @ersinciftci
#1772 BasePath can't be defined without host @astafev
#1770 SNAPSHOT breaks @value placeholder replacement @stacysimpson
#1767 Unable to implement and use ApiListingScannerPlugin @stacysimpson
#1749 Error resolving $ref pointer for input DTO @gionn
#1746 How to override API-Documentation of generated endpoints (spring-data-rest) @florianrusch
#1734 swagger ui not showing the default parameter value zero @liudonghua123
#1732 Default value of "supportedSubmitMethods" in springfox.js @thadc23
#1727 Jackson required/optional @raderio
#1726 @SiZe is not working @raderio
#1725 If you have both Read and Write operation in single Controller readOnly do not work. But if only Write it works. @dzmitryhil
#1724 Swagger methods in multiple groups being renamed @nitin02
#1708 @EnableSwagger2 interfering with application configuration. @rycentious
#1706 X-Forwarded-Port NumberFormatException: For input string: "443,443" looking-for-contributions @sixcorners
#1698 [BUG] custom swagger endpoint returns a 404. Default endpoint works. @ahatzz11
#1697 Problem with direct model substitution @cbornet
#1677 OAuth2 request adds vendorExtension scope to all auth requests @pmlido
#1676 Invalid attributes that starts with x or y @isolisduran
#1670 Question: how to use @ApiParam annotation on a parameter defined in an interface? @taxone
#1666 AllowableValues blank for Optional parameter @madgnome
#1651 ResponseHeaders do not preserve lexical ordering question @ahatzz11
#1648 Operation ordering is not working @neil
#1632 Invalid response model for class with name "File" @dreambrother
#1623 Swagger annotations like @ApiParam, @ApiOperation annotation work for Spring Data Rest operations @taxone
#1615 api_docs shows content but swagger-ui (2.6.1) is empty @StefanSchubert
#1613 HTML code in API description in ignored using springfox-swagger-ui 2.6.1 @anouarchattouna
#1605 Response with a byte array does not work as expected @maukito
#1603 StackOverflowError on swagger generation @jmattheis
#1597 @ApiParam value is not respected @sta
#1594 IndexOutofBoundException when using unbounded Map models @sac10nikam
#1588 springfox-data-rest : @param annotation not supported @tooms4444
#1580 Can't expand the operation when I set @Api tags by chinese wontfix @letorn
#1571 2.6.1 Cannot read property of custom enum list @jearton
#1569 When using ApiKey "keyname" is mapped incorrectly in progress @jmattheis
#1507 Broken basePath with AbstractPathProvider in version 2.5.0 of springfox-swagger2 @danielbcorreia
#1435 Setting a Custom basePath Requires Setting a Static Host in 2.5 looking-for-contributions @asdcdow

Assets 2

2.6.1 Release Notes

07 Nov 01:53
@dilipkrish dilipkrish
2.6.1
94f4d3f
Compare
Choose a tag to compare
2.6.1 Release Notes

cvjuq7ywiaaeog2
Photo courtesy National Geographic

A big thank you for reporting bugs and

Pull Requests 🙇

Features

Bug Fixes

  • (#1531) UI configuration problem when not using jackson @yangyang0507
  • (#1562) IndexOutOfBoundsException in ModelMapper @lhanson
  • (#1558) Coercing Optional to String @kevinm416
  • (#1555) Dead circulation @evencht
  • (#1554) spec violation: springfox generates json without parameter type for @RequestParam Map<String, String> wontfix @Nikit
  • (#1553) After updating to 2.6, stack overflow exception is occured @HanDDol
  • (#1550) Custom endpoint not working @raderio
  • (#1542) @EnableSwagger2 forces microservice to register as UNKNOWN to registry @martin3361
  • (#1540) ApiImplicitParams documentation lacks Model and Model Schema for user-defined types @richmeyer7
  • (#1538) SpringDataRestConfiguration ModelAttributeParameterExpander StackOverflowError @mpostelnicu
  • (#1532) SpringFox and Eureka failing @sundarsy
  • (#1528) The service does not work after using Swagger 2.6 in Spring Cloud @puras
  • (#1525) 2.6.0 breaks the swagger documentation link @apixandru
  • (#1514) Properties are not read anymore (regression) @cbornet
  • (#1513) Respect ApiModelProperty(hidden=true) on @ModelAttribute annotated models, Cycles in Java classes cause infinite loop has-workaround @leelance
  • (#1508) Update overrides the default behavior for the PropertyPlaceholderHelper @apixandru
Assets 2

2.6.0 Release Notes

04 Oct 03:59
@dilipkrish dilipkrish
2.6.0
9c34ed5
Compare
Choose a tag to compare
2.6.0 Release Notes

The one where spring data rest support lands!

The one that you've all been waiting for :)

image courtesy @SWildlifepics

This is the initial support, its is still rough would love to have feedback to improve support.

PR's

Thank you for all your contributions!

Features

Bug fixes

  • (#1504) "infinity" in allowableValues property of @ApiModelProperty annotation @SomeoneToIgnore
  • (#1485) Remove duplicate values in enum displays (case insensitive) @apixandru
  • (#1475) Map<LocalDateTime, List> not displayed correctly @jlaugesen
  • (#1440) Springfox expects _links to be array, while Spring hateoas return _links as object @jiangchuan1220
  • (#1436) Explicit value JsonProperty ignored when PropertyNamingStrategy is configured not-reproducable @mborkunov
  • (#1420) Result of adding tags to docket in swagger configuration @ChrisHartman
  • (#1380) ApiResponses can not support custom status code such like 1010 @dockerlet
  • (#1361) Request header "Content-Type" is not being sent with request wontfix @manish2aug
  • (#1353) RequestParam with a map crashes swagger-ui wontfix @BryceMehring
  • (#1346) @ApiIgnore is not respected on a method @ben
Assets 2

Announcing 2.5.0 Release!

07 Jun 00:37
@dilipkrish dilipkrish
2.5.0
c4055d4
Compare
Choose a tag to compare
Announcing 2.5.0 Release!

cjkvpocweai1np-
Photo courtesy: https://twitter.com/swildlifepics/status/736672399958114304

Features

Bugs

  • (#1325) Missing @RequestParam on a boolean parameter causes Swagger page to not render that controller, and all controllers alphabetically after has-workaround @Thunderforge
  • (#1321) Cannot fully change swagger and swagger ui path has-workaround @nikit-cpp
  • (#1133) Respect ApiModelProperty(hidden=true) on @ModelAttribute annotated models has-workaround @cm325
  • (#1317) @ApiModelProperty(value="something") on bean annotated with @ModelAttribute changes dataType to "ref" @mpostelnicu
  • (#1310) 'enum' query parameter type(annotated with @ModelAttribute) is 'ref'. @namkee
  • (#1306) Maps as parameters were not rendered correctly @aqlu
  • (#1285) dataType="file" is not working in springfox 2.4.0 @HDBandit
  • (#1282) Missing model definitions in swagger json document when return type is array syntax (CustomModel[]) @namkee
  • (#1280) @ApiModelProperty.position not respected @marceloverdijk
  • (#1268) Compatible issue encountered with Spring Boot 1.4.0.M2 and Spring 4.3.RC @hantsy
  • (#1260) Not working proper with query params not-reproducable @Gaurav-Deshkar
  • (#1258) Fields not visible from children when implementing interfaces in parent request objects @stashthecode 2 of 2
  • (#1249) Bug: Templated url are submited with the template part @anthofo
  • (#1241) Overloaded method resolution was incorrect causing ArrayIndexOutOfBoundsException @tdeverdiere
  • (#1238) Swagger UI showing incorrect URLs @martin3361
  • (#1211) ApiParam allowableValues string with spaces @pvpkiran
  • (#1209) Query parameters - complex data types are coerced to 'string' type, especially collections @jkasmann
  • (#1207) CachingModelPropertiesProvider - NullPointerException @bharatkaushik
  • (#1203) swagger-ui location /configuration/ui configurable? @flexguse
  • (#1196) Springfox not emitting attributes for definitions with some kinds of circular references @benfowler

PRs

Maintenance

Not to mention all the questions and suggestions by the community!! 🤘

Assets 2

Announcing 2.4.0!

03 Mar 02:25
@dilipkrish dilipkrish
2.4.0
10b839f
Compare
Choose a tag to compare
Announcing 2.4.0!

Image Of Release Fox
©️ Image courtesy of Richard Spiller@flickr

Features

(#1145) Generated file is not compatible with Swagger specification if method parameter is Object and is used as path parameter @tjuchniewicz
(#1122) Default page served isn't configurable and lacks search / listAll functionality @porcoesphino
(#1087) Change hardcoded "api_key" @JulianaRed
(#1061) Add support @RequestParam of type Map<String, String> @matias2681
(#1046) Control over swagger contact object @smwurster
(#1037) Add support for multiple allowable values @smwurster
(#1023) Provide a method for Model Properties to by sorted by configurable methods @nickpanaiotov
(#969) Support alternate type resolution for @ModelAttribute annotated model fields @ejain
(#937) Add support for @ResponseHeader @MarkVanVenrooij
(#936) Add support for adding global tags to the docket @dilipkrish
(#735) Support for adding additional models for request or response that are not inferred from operationshas-workaround @cabbonizio
(#388) @ApiParam not working on Interface method declarations @charleslieferando
(#356) Support for JSR-303 (Java Bean Validation) @omayevskiy

Bugs

(#1194) Swagger-ui does not render correctly in safari
@dilipkrish
(#1193) NPE when Feign, Swagger and Spring Security are used - Brixton.BUILD-SNAPSHOT @varghgeorge
(#1186) Unwanted class with map of map attribute @cbornet
(#1174) Doc: includePatterns does not exist (anymore?) can-use-for-docs @vorburger
(#1147) Using parameterized types using Void resulting in invalid Swagger @nigelsim
(#1132) Api operations on abstract superclass not affected by @API tags @gionn
(#1129) Swagger2Controller.getDocumentation get IndexOutOfBoundsException @yqzhan2014
(#1127) Setup base URL after Swagger UI is initialized #1126 @chornyi
(#1126) Race condition and crash on Swagger UI startup @chornyi
(#1125) Service description has no api's as the path regular expression does not match any of the service @irfandawood
(#1051) Customised ObjectMapper not recognized @milanov
(#953) NullPointerException when extending controller classes with multiple parameterized types @woemler
(#902) @ApiImplicitParam: "array" dataType is getting resolved into "type":"ref" @anny-ts

Maintenance

(#1180) Supply the text values for `@ApiOperation, @ApiResponse, @ApiParam, @ApiModelProperty from an external resource file, instead of hardcoding? @joetconcur
(#1168) Changelog not being updated question @jayanderson
(#1161) Update documentation for JSR310 and Joda dates @cbornet
(#1142) Fix the reference document not showing versions correctly in the gh pages @dilipkrish
(#854 ) Rework the ModelRef design to not be a hacky project of the swagger models @dilipkrish

A BIG thank you 🙇 for all the questions/issues/comments and contributions to make this a better product!

PRs in this release!

(#1189) Allow extension of ApiResourceController by making its methods public @gmarziou
(#1165) ParameterDefaultReader in swagger does not honor other annotations usage of DefaultValue @ctruzzi
(#1163) Updated the Docket XML Configuration Documentation @kellydavid
(#1159) Add basic Bean validation api (JSR-303) support @jfiala
(#1127) Setup base URL after Swagger UI is initialized #1126 @chornyi

Assets 2

2.3.1

04 Jan 02:57
@dilipkrish dilipkrish
2.3.1
8fe5c08
Compare
Choose a tag to compare
2.3.1

Maintenance

  • Remove runtime dependency on spring-hateoas #1104
  • Fix the accidental reference to java.util.Objects class so that java 6 is still supported
  • Upgraded gradle to 2.10
  • Upgraded to swagger 1.5.5
  • Fix Documentation Formatting
  • Upgraded jdk to 8 for building
  • Upgrade Classmate to 1.3.1 #1079
  • Document use of google guava in code examples #1117

Pull Requests

  • v2/api-docs does not support application/json media type by default #1110
  • Add support for api model property positions. feature PR #1101

Bug Fixes

  • Could not define global consumes and produces set #1115
  • Support for showing controller methods with defaulted @RequestMapping#params values with different values is incorrect #1114
  • Better Support for 2 dimensional arrays #956

Big thank you to @wxjlibra, @abaile33 for reporting bugs and Thanks @sbuettner and @vmarusic for the PRs!

Assets 2