Skip to content

Commit a849ebf

Browse files
dunglasjaviereguiluz
authored andcommitted
Fix \"API Platform\" case and various relative fixes
1 parent 7d89756 commit a849ebf

File tree

3 files changed

+21
-6
lines changed

3 files changed

+21
-6
lines changed

components/serializer.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1424,7 +1424,7 @@ Learn more
14241424
.. seealso::
14251425

14261426
Normalizers for the Symfony Serializer Component supporting popular web API formats
1427-
(JSON-LD, GraphQL, HAL and JSONAPI) are available as part of the `API Platform`_ project.
1427+
(JSON-LD, GraphQL, OpenAPI, HAL, JSON:API) are available as part of the `API Platform`_ project.
14281428

14291429
.. seealso::
14301430

quick_tour/flex_recipes.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Are you building an API? You can already return JSON easily from any controller:
174174
}
175175
}
176176

177-
But for a *truly* rich API, try installing `Api Platform`_:
177+
But for a *truly* rich API, try installing `API Platform`_:
178178

179179
.. code-block:: terminal
180180
@@ -259,5 +259,5 @@ build features *without* sacrificing code quality or performance. It's all about
259259
the service container, and it's Symfony's super power. Read on: about :doc:`/quick_tour/the_architecture`.
260260

261261
.. _`https://flex.symfony.com`: https://flex.symfony.com
262-
.. _`Api Platform`: https://api-platform.com/
262+
.. _`API Platform`: https://api-platform.com/
263263
.. _`Twig`: https://twig.symfony.com/

serializer.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -202,8 +202,19 @@ value:
202202
Going Further with the Serializer
203203
---------------------------------
204204

205-
`ApiPlatform`_ provides an API system supporting `JSON-LD`_ and `Hydra Core Vocabulary`_
206-
hypermedia formats. It is built on top of the Symfony Framework and its Serializer
205+
`API Platform`_ provides an API system supporting the following formats:
206+
207+
* `JSON-LD`_ along with the `Hydra Core Vocabulary`_
208+
* `OpenAPI`_ v2 (formerly Swagger) and v3
209+
* `GraphQL`_
210+
* `JSON:API`_
211+
* `HAL`_
212+
* JSON
213+
* XML
214+
* YAML
215+
* CSV
216+
217+
It is built on top of the Symfony Framework and its Serializer
207218
component. It provides custom normalizers and a custom encoder, custom metadata
208219
and a caching system.
209220

@@ -218,7 +229,11 @@ take a look at how this bundle works.
218229
serializer/custom_normalizer
219230

220231
.. _`APCu`: https://github.com/krakjoe/apcu
221-
.. _`ApiPlatform`: https://github.com/api-platform/core
232+
.. _`API Platform`: https://api-platform.com
222233
.. _`JSON-LD`: http://json-ld.org
223234
.. _`Hydra Core Vocabulary`: http://hydra-cg.com
235+
.. _`OpenAPI`: https://www.openapis.org
236+
.. _`GraphQL`: https://graphql.org
237+
.. _`JSON:API`: https://jsonapi.org
238+
.. _`HAL`: http://stateless.co/hal_specification.html
224239
.. _`Data URIs`: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs

0 commit comments

Comments
 (0)