RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 23:59:26 +03:00
Code Issues Projects Releases Wiki Activity

Add links to swagger php examples

Browse Source
This commit is contained in:
Guilhem Niot 2022-04-21 23:36:09 +02:00 committed by GitHub
parent 35ea6f2759
commit 05d16e6814
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Resources/doc/index.rst
View File

@ -99,7 +99,7 @@ Using the bundle
---------------- ----------------
You can configure global information in the bundle configuration ``documentation.info`` section (take a look at You can configure global information in the bundle configuration ``documentation.info`` section (take a look at
`the OpenAPI 3.0 specification (formerly Swagger)`_ to know the available fields): `the OpenAPI 3.0 specification (formerly Swagger)`_ to know the available fields).
.. code-block:: yaml .. code-block:: yaml
@ -127,7 +127,12 @@ You can configure global information in the bundle configuration ``documentation
.. note:: .. note::
If you're using Flex, this config is there by default. Don't forget to adapt it to your app! If you're using Flex, this config is there by default under ``config/packages/nelmio_api_doc.yaml``. Don't forget to adapt it to your app!
.. tip::
This configuration field can more generally be used to store your documentation as yaml.
You may find in the ``.yaml`` files from `SwaggerPHP examples`_.
To document your routes, you can use the SwaggerPHP annotations and the To document your routes, you can use the SwaggerPHP annotations and the
``Nelmio\ApiDocBundle\Annotation\Model`` annotation in your controllers:: ``Nelmio\ApiDocBundle\Annotation\Model`` annotation in your controllers::
@ -174,6 +179,12 @@ To document your routes, you can use the SwaggerPHP annotations and the
The normal PHPdoc block on the controller method is used for the summary and description. The normal PHPdoc block on the controller method is used for the summary and description.
.. tip::
Examples of using the annotations can be found in `SwaggerPHP examples`_.
However, unlike in those examples, when using this bundle you don't need to specify paths and you can easily document models as well as some
other properties described below as they can be automatically be documented using the Symfony integration.
Use models Use models
---------- ----------
@ -343,6 +354,7 @@ If you need more complex features, take a look at:
faq faq
security security
.. _`SwaggerPHP examples`: https://github.com/zircote/swagger-php/tree/master/Examples
.. _`Symfony PropertyInfo component`: https://symfony.com/doc/current/components/property_info.html .. _`Symfony PropertyInfo component`: https://symfony.com/doc/current/components/property_info.html
.. _`willdurand/Hateoas`: https://github.com/willdurand/Hateoas .. _`willdurand/Hateoas`: https://github.com/willdurand/Hateoas
.. _`BazingaHateoasBundle`: https://github.com/willdurand/BazingaHateoasBundle .. _`BazingaHateoasBundle`: https://github.com/willdurand/BazingaHateoasBundle