This is not full backward compatible release, as the format of storing
examples changed from YAML to JSON: the default location is at
doc/apipie_examples.json
. The migration should be as easy as
running:
rake apipie:convert_examples
Also please not Rails 3.0 support was deprecated and the compatibility wont be tracked anymore in next releases.
- dump examples as json #125 @johanneswuerbach
- support for localized API documentation #232 @mbacovsky
- configuration option to always record examples #239 @arathunku
- deprecate Rails 3.0 #241 @iNecas
- reloading works correctly with to_prepare blocks in the app #228 @iNecas
- documentation bootstrapping now respects api_controllers_matcher #227 @clamoris
- backward compatibility with Ruby 1.8 #218 @mbacovsky
- checksum calculation is lazy and respect use_cache config #220 @mbacovsky
- fix generating the cache in production environment #223 @iNecas
- fix loading regression with SafeYAML #224 @iNecas
- middleware for computing Apipie checksum for dynamic bindings #215 @mbacovsky
api_base_url
inherited properly #214 @mbacovsky- ability to hide specific parameters #208 @nathanhoel
- fix for SafeYAML compatibility #207 @pivotalshiny
- option to show all examples in the documentation #203 @pivotalshiny
- support for array of hashes validation #189 @mtparet
- support for saving the values based on documentation into
@api_params
variable #188 @mtparet - support for json generated from rake task
rake apipie:static_json
#186 @mtparet - fix
undefined method 'has_key?' for nil:NilClass
when validating Hash against non-hash value #185 @mtparet - fix NoMethorError when validating Hash against non-hash value #183 @nathanhoel
- support for metadata for params #181 @tstrachota
- fix camelization of class names #170 @yonpols
- new array class validator #169 @mkrajewski
- fix DOS vulnerability for running in production without use_cache
- ability to load descriptions from external files
- improved examples extractor
- fixed deprecation warnings in Rails 4
- using StandardError instead of Exception for errors
- fix exceptions on unknown validator
- fix concerns substitution in parameters
- possibility to authenticate the API doc
- support for array in api_controllers_matcher
- fix "named_resources" option
- fix generating static files when concerns used
- fix RDoc 4.0 compatibility issue
validate_value
andvalidate_presence
options for better validation granularity
- namespaced resources - prevent collisions when one resource defined in more modules
Apipie::DSL::Concern
for being able to use the DSL in module that is included into controllers
- fix examples recording when resource_id is set
- use safe_yaml for loading examples file when available
param_group
anddef_param_group
keywords:action_aware
options for reusing param groups for create/update actions
- support for multiple see links at action and ability to provide description of see links
- Fix getting started being rendered even when documentation was available
- Fix case when there is no documentation yet: with link to how to start
- Fix handling bad requests when cache is on
- Fix params extractor in case there is already some documentation