Generates documentation for your REST API from annotations
MIT License
Bot releases are hidden (Show)
Published by willdurand almost 9 years ago
Hi!
(Please read the text below, thanks!)
This release contains numerous fixes and a few improvements. Most of them are related to newer versions of different dependencies. For instance, this bundle now requires Symfony 2.3+ (it does not work well with 2.8|3.0 though). Take a look at the CHANGELOG section at the end of this page for more information. Thank you to all contributors!
I refactored the test suite a bit in order to speed it up, nothing fancy here but the feedback loop gets better. Talking about it, I am alone maintaining this bundle I've created more than 3 years ago. However, I don't have the opportunity to use it anymore, so it is rather complicated to check Pull Requests and to fix bugs. It took me some time to understand why the test suite was failing for weeks.
Now that it is back to green, I decided to close all open PRs, because CI statuses are "stale" (i.e. statuses don't reflect the real statuses of the PRs). It does not mean that I won't accept PRs anymore, but it is time to start from scratch. That is why all PRs are now closed. I hope you will better understand why I did that now (note also that I closed all PRs using the GitHub interface, that is why I didn't leave any message...).
Anyway, v2.10 should be pretty stable (most of the other versions were stable) and should work well with all stable Symfony versions. What I'd like to do first is:
DunglasApiBundle
. This feature introduced in a previous version is not stable enough, due to recent changes. It is an optional dependency and feature, so it should not impact many users, but it would be nice to have a good integration of this bundle, because it deserves it :)I will continue to maintain this bundle, to fix bugs, and to merge new features. This bundle has been installed more than 2 million times. 2 million. That's a lot, and it is constantly increasing (according to Packagist), which means this bundle is more and more used. Behind these numbers, there are developers just like you and me. If you use this bundle, and want to give it some love like these 100 awesome developers already, please contribute!
You can ping me on Twitter if you want to talk to me.
Thank you,
William.
JsonSerializable
classesname
in the input and output options for JsonSerializable
and validation parsersQueryParam
or RequestParam
true/false/null
default values on configurationview
option to api:doc:dump commandApiDocExtractor
to accept callable classes as controllersDunglasApiBundle
getViewCache()
method visibility to private
FormType::setDefaultOptions()
usagePublished by willdurand over 9 years ago
In this release, there a two major features:
Thanks to all contributors!
api_key
to query if emptyPublished by willdurand over 9 years ago
A lot of fixes have been pushed since 2.7.0
, but this release also contains numerous new features such as a great Swagger support, UI/UX improvements, and a few new ways to retrieve useful information.
For more information, please read the changelog below.
@link
annotation and add testsjQuery.size()
methodPublished by willdurand about 10 years ago
This release contains numerous fixes and improvements as well as new shiny features.
The sandbox now supports different authentication schemes such as http
+ basic
or bearer
. The http_basic
delivery has been kept for BC purpose but will be remove at some point. You should rather use the new type
parameter:
# app/config/config.yml
nelmio_api_doc:
sandbox:
authentication: # default is `~` (`null`), if set, the sandbox automatically
# send authenticated requests using the configured `delivery`
name: access_token # access token name or query parameter name or header name
delivery: http # `query`, `http`, and `header` are supported
# Required if http delivery is selected.
type: basic # `basic`, `bearer` are supported
The sandbox now displays better input HTML elements depending on the type of each field. It is also possible to disable the "body formats" select box and links to the Symfony web profiler have been added.
For more information, please read the changelog below.
JSM\Inline
(#372)LINK
in uppercase what then is denied by nginx. More info: http://stackoverflow.com/questions/9645037/nginx-rejects-custom-http-methods-if-not-all-upper-case
default
parameters in {JmsMetadata,Validator}Parser
, and FOSRestHandler
FormTypeParser
nullable
option in RequestParam
PostParserInterface
to JmsMetadataParser
to get ValidatorParser
found children parsedFormTypeParser
, FormType
constructor should be called when possiblea>div
ul>li
Published by willdurand over 10 years ago
@ApiDoc
annotation gets a new property named tags
, which allow to tag a method (e.g. beta
or in-development
). You can configure either a single tag or an array of tags.request_format
configuration node, there is a new available node named request_formats
, allowing you to register custom mime types for XML and JSON formats:# app/config/config.yml
nelmio_api_doc:
sandbox:
request_format:
formats: # default `json` and `xml`,
json: application/json # override to add custom formats or disable
xml: application/xml # default formats
MetadataFactory
Published by willdurand over 10 years ago
ValidatorParser
in Symfony 2.5Published by willdurand over 10 years ago
Also, the bundle is now tested against PHP 5.6 and HHVM on Travis-CI.
Published by willdurand over 10 years ago
exclude_envs
to ApiDoc annotation to exclude the documentation from the specified environmentsPublished by willdurand almost 11 years ago