You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: admin/getting-started.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Installation
4
4
5
-
If you use the [API Platform Distribution](../distribution/), API Platform Admin is already installed, you can skip this installation guide.
5
+
If you use the [API Platform Symfony variant](../symfony/), API Platform Admin is already installed, you can skip this installation guide.
6
6
7
7
Otherwise, follow this guide.
8
8
@@ -37,7 +37,7 @@ export default () => (
37
37
Be sure to make your API send proper [CORS HTTP headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) to allow
38
38
the admin's domain to access it.
39
39
40
-
To do so, if you use the API Platform Distribution, update the value of the `CORS_ALLOW_ORIGIN` parameter in `api/.env` (it will be set to `^https?://localhost:?[0-9]*$`
40
+
To do so, if you use the API Platform Symfony variant, update the value of the `CORS_ALLOW_ORIGIN` parameter in `api/.env` (it will be set to `^https?://localhost:?[0-9]*$`
41
41
by default).
42
42
43
43
If you use a custom installation of Symfony and [API Platform Core](../core/), you will need to adjust the [NelmioCorsBundle configuration](https://github.com/nelmio/NelmioCorsBundle#configuration) to expose the `Link` HTTP header and to send proper CORS headers on the route under which the API will be served (`/api` by default).
Copy file name to clipboardExpand all lines: admin/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ library to expose a nice, responsive, management interface (Create-Retrieve-Upda
17
17
18
18
You can **customize everything** by using provided React Admin and [MUI](https://mui.com/) components, or by writing your custom [React](https://reactjs.org/) components.
19
19
20
-
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform/react-admin?cid=apip"><imgsrc="../distribution/images/symfonycasts-player.png"alt="React Admin Screencast"><br>Watch the React Admin screencast</a></p>
20
+
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform/react-admin?cid=apip"><imgsrc="../symfony/images/symfonycasts-player.png"alt="React Admin Screencast"><br>Watch the React Admin screencast</a></p>
Copy file name to clipboardExpand all lines: core/content-negotiation.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Using the raw JSON or raw XML formats is discouraged, prefer using JSON-LD inste
9
9
10
10
API Platform also supports [JSON Merge Patch (RFC 7396)](https://tools.ietf.org/html/rfc7396) the JSON:API[`PATCH`](https://jsonapi.org/format/#crud-updating) formats, as well as [Problem Details (RFC 7807)](https://tools.ietf.org/html/rfc7807), [Hydra](https://www.hydra-cg.com/spec/latest/core/#description-of-http-status-codes-and-errors) and [JSON:API](https://jsonapi.org/format/#errors) error formats.
11
11
12
-
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform/formats?cid=apip"><imgsrc="/docs/distribution/images/symfonycasts-player.png"alt="Formats screencast"><br>Watch the Formats screencast</a></p>
12
+
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform/formats?cid=apip"><imgsrc="/docs/symfony/images/symfonycasts-player.png"alt="Formats screencast"><br>Watch the Formats screencast</a></p>
13
13
14
14
API Platform will automatically detect the best resolving format depending on:
Copy file name to clipboardExpand all lines: core/extending-jsonld-context.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## JSON-LD
4
4
5
-
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform/json-ld?cid=apip"><imgsrc="/docs/distribution/images/symfonycasts-player.png"alt="JSON-LD screencast"><br>Watch the JSON-LD screencast</a></p>
5
+
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform/json-ld?cid=apip"><imgsrc="/docs/symfony/images/symfonycasts-player.png"alt="JSON-LD screencast"><br>Watch the JSON-LD screencast</a></p>
6
6
7
7
API Platform provides the possibility to extend the JSON-LD context of properties. This allows you to describe JSON-LD-typed
8
8
values, inverse properties using the `@reverse` keyword and you can even overwrite the `@id` property this way. Everything you define
@@ -63,7 +63,7 @@ Note that you do not have to provide the `@id` attribute. If you do not provide
63
63
64
64
## Hydra
65
65
66
-
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform/hydra?cid=apip"><imgsrc="/docs/distribution/images/symfonycasts-player.png"alt="Hydra screencast"><br>Watch the Hydra screencast</a></p>
66
+
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform/hydra?cid=apip"><imgsrc="/docs/symfony/images/symfonycasts-player.png"alt="Hydra screencast"><br>Watch the Hydra screencast</a></p>
67
67
68
68
It's also possible to replace the Hydra context used by the documentation generator:
Copy file name to clipboardExpand all lines: core/extending.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,4 +35,4 @@ For instance, if you want to send a mail after a resource has been persisted, bu
35
35
36
36
To replace existing API Platform services with your decorators, [check out how to decorate services](https://symfony.com/doc/current/service_container/service_decoration.html).
37
37
38
-
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform-security/service-decoration?cid=apip"><imgsrc="/docs/distribution/images/symfonycasts-player.png"alt="Service Decoration screencast"><br>Watch the Service Decoration screencast</a></p>
38
+
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform-security/service-decoration?cid=apip"><imgsrc="/docs/symfony/images/symfonycasts-player.png"alt="Service Decoration screencast"><br>Watch the Service Decoration screencast</a></p>
Copy file name to clipboardExpand all lines: core/filters.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ By default, all filters are disabled. They must be enabled explicitly.
12
12
When a filter is enabled, it automatically appears in the [OpenAPI](openapi.md) and [GraphQL](graphql.md) documentations.
13
13
It is also automatically documented as a `hydra:search` property for JSON-LD responses.
14
14
15
-
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform/filters?cid=apip"><imgsrc="/docs/distribution/images/symfonycasts-player.png"alt="Filtering and Searching screencast"><br>Watch the Filtering & Searching screencast</a></p>
15
+
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform/filters?cid=apip"><imgsrc="/docs/symfony/images/symfonycasts-player.png"alt="Filtering and Searching screencast"><br>Watch the Filtering & Searching screencast</a></p>
Copy file name to clipboardExpand all lines: core/getting-started.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ If you plan to migrate from FOSRestBundle, you might want to read [this guide](m
6
6
7
7
## Installing API Platform
8
8
9
-
If you are starting a new project, the easiest way to get API Platform up is to install the [API Platform Distribution](../distribution/index.md).
9
+
If you are starting a new project, the easiest way to get API Platform up is to install the [API Platform Distribution](../symfony/index.md).
10
10
It comes with the API Platform core library integrated with [the Symfony framework](https://symfony.com), [the schema generator](../schema-generator/),
[NelmioCorsBundle](https://github.com/nelmio/NelmioCorsBundle) and [Behat](https://behat.org/).
@@ -24,13 +24,13 @@ There are no mandatory configuration options although [many settings are availab
24
24
25
25
## Before Reading this Documentation
26
26
27
-
If you haven't read it already, take a look at [the Getting Started guide](../distribution/index.md).
27
+
If you haven't read it already, take a look at [the Getting Started guide](../symfony/index.md).
28
28
This tutorial covers basic concepts required to understand how API Platform works including how it implements the REST pattern
29
29
and what [JSON-LD](https://json-ld.org/) and [Hydra](https://www.hydra-cg.com/) formats are.
30
30
31
31
## Mapping the Entities
32
32
33
-
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform/api-resource?cid=apip"><imgsrc="/docs/distribution/images/symfonycasts-player.png"alt="Create an API Resource screencast"><br>Watch the Create an API Resource screencast</a></p>
33
+
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/screencast/api-platform/api-resource?cid=apip"><imgsrc="/docs/symfony/images/symfonycasts-player.png"alt="Create an API Resource screencast"><br>Watch the Create an API Resource screencast</a></p>
34
34
35
35
API Platform is able to automatically expose entities mapped as "API resources" through a REST API supporting CRUD
Copy file name to clipboardExpand all lines: core/graphql.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ docker compose exec php sh -c '
21
21
22
22
You can now use GraphQL at the endpoint: `https://localhost:8443/graphql`.
23
23
24
-
*Note:* If you used [Symfony Flex to install API Platform](../distribution/index.md#using-symfony-flex-and-composer-advanced-users), URLs will be prefixed with `/api` by default. For example, the GraphQL endpoint will be: `https://localhost:8443/api/graphql`.
24
+
*Note:* If you used [Symfony Flex to install API Platform](../symfony/index.md#using-symfony-flex-and-composer-advanced-users), URLs will be prefixed with `/api` by default. For example, the GraphQL endpoint will be: `https://localhost:8443/api/graphql`.
@@ -43,6 +43,6 @@ This bundle is extensively tested (unit and functional). The [`Fixtures/` direct
43
43
44
44
## Screencasts
45
45
46
-
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/tracks/rest?cid=apip#api-platform-3"><imgsrc="/docs/distribution/images/symfonycasts-player.png"alt="SymfonyCasts, API Platform screencasts"></a></p>
46
+
<palign="center"class="symfonycasts"><ahref="https://symfonycasts.com/tracks/rest?cid=apip#api-platform-3"><imgsrc="/docs/symfony/images/symfonycasts-player.png"alt="SymfonyCasts, API Platform screencasts"></a></p>
47
47
48
48
The easiest and funniest way to learn how to use API Platform is to watch [the more than 60 screencasts available on SymfonyCasts](https://symfonycasts.com/tracks/rest?cid=apip#api-platform-3)!
0 commit comments