Skip to content

Commit aa441c6

Browse files
sandobasoyuka
authored andcommitted
Update links, fix spelling errors & language
1 parent 367d800 commit aa441c6

37 files changed

+92
-92
lines changed

admin/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
![Screencast](images/admin-demo.gif)
44

55
API Platform Admin is a tool to automatically create a beautiful (Material Design) and fully-featured administration interface
6-
for any API supporting [the Hydra Core Vocabulary](http://www.hydra-cg.com/), exposing an [OpenAPI documentation](https://www.openapis.org/)
6+
for any API supporting [the Hydra Core Vocabulary](https://www.hydra-cg.com/), exposing an [OpenAPI documentation](https://www.openapis.org/)
77
or other API specification formats supported by [`@api-platform/api-doc-parser`](https://github.com/api-platform/api-doc-parser).
88

99
API Platform Admin is the perfect companion of APIs created

core/angularjs-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Warning: for a new project, you should consider using [the API Platform's Progre
55

66
## Restangular
77

8-
API Platform works fine with [AngularJS v1](http://angularjs.org). The popular [Restangular](https://github.com/mgonto/restangular)
8+
API Platform works fine with [AngularJS v1](https://angularjs.org/). The popular [Restangular](https://github.com/mgonto/restangular)
99
REST client library for Angular can easily be configured to handle the API format.
1010

1111
Here is a working Restangular config:

core/content-negotiation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ Format | Format name |
2222
----------------------------------------------------------------|--------------|-------------------------------|----------------------------------------
2323
[JSON-LD](https://json-ld.org) | `jsonld` | `application/ld+json` | yes
2424
[GraphQL](graphql.md) | n/a | n/a | yes
25-
[JSON:API](http://jsonapi.org/) | `jsonapi` | `application/vnd.api+json` | yes
25+
[JSON:API](https://jsonapi.org/) | `jsonapi` | `application/vnd.api+json` | yes
2626
[HAL](https://stateless.group/hal_specification.html) | `jsonhal` | `application/hal+json` | yes
27-
[YAML](http://yaml.org/) | `yaml` | `application/x-yaml` | no
27+
[YAML](https://yaml.org/) | `yaml` | `application/x-yaml` | no
2828
[CSV](https://tools.ietf.org/html/rfc4180) | `csv` | `text/csv` | no
2929
[HTML](https://whatwg.org/) (API docs) | `html` | `text/html` | no
3030
[XML](https://www.w3.org/XML/) | `xml` | `application/xml`, `text/xml` | no
@@ -119,7 +119,7 @@ Additionally the `csv` format is added with the MIME type `text/csv`.
119119
It is also important to notice that the usage of this attribute will override the formats defined in the configuration, therefore
120120
this configuration might disable the `json` or the `html` on this resource for example.
121121

122-
You can specify different accepted formats at operation level too, it's especially convenient for to configure formats available for the `PATCH` method:
122+
You can specify different accepted formats at operation level too, it's especially convenient to configure formats available for the `PATCH` method:
123123

124124
[codeSelector]
125125

@@ -183,7 +183,7 @@ resources:
183183
## Supporting Custom Formats
184184

185185
The API Platform content negotiation system is extendable.
186-
You can add support for formats not available by default by creating custom normalizer and encoders.
186+
You can add support for formats not available by default by creating custom normalizers and encoders.
187187
Refer to the Symfony documentation to learn [how to create and register such classes](https://symfony.com/doc/current/serializer.html#adding-normalizers-and-encoders).
188188

189189
Then, register the new format in the configuration:

core/controllers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Note: using custom controllers with API Platform is **discouraged**. Also, Graph
44
[For most use cases, better extension points, working both with REST and GraphQL, are available](design.md).
55

66
API Platform can leverage the Symfony routing system to register custom operations related to custom controllers. Such custom
7-
controllers can be any valid [Symfony controller](http://symfony.com/doc/current/book/controller.html), including standard
7+
controllers can be any valid [Symfony controller](https://symfony.com/doc/current/controller.html), including standard
88
Symfony controllers extending the [`Symfony\Bundle\FrameworkBundle\Controller\AbstractController`](http://api.symfony.com/4.1/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.html)
99
helper class.
1010

@@ -15,7 +15,7 @@ implements the [Action-Domain-Responder](https://github.com/pmjones/adr) pattern
1515
The distribution of API Platform also eases the implementation of the ADR pattern: it automatically registers action classes
1616
stored in `api/src/Controller` as autowired services.
1717

18-
Thanks to the [autowiring](http://symfony.com/doc/current/components/dependency_injection/autowiring.html) feature of the
18+
Thanks to the [autowiring](https://symfony.com/doc/current/service_container/autowiring.html) feature of the
1919
Symfony Dependency Injection container, services required by an action can be type-hinted in its constructor, it will be
2020
automatically instantiated and injected, without having to declare it explicitly.
2121

@@ -433,7 +433,7 @@ resources:
433433
[/codeSelector]
434434

435435
API Platform will automatically map this `post_publication` operation to the route `book_post_publication`. Let's create a custom action
436-
and its related route using annotations:
436+
and its related route using attributes:
437437

438438
```php
439439
<?php

core/deprecations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ It's a tedious task that should be avoided as much as possible.
99
On the other hand, the evolution strategy (also known as versionless APIs) consists of deprecating the fields, resources
1010
types or operations that will be removed at some point.
1111

12-
Most modern API formats including [JSON-LD / Hydra](content-negotiation.md), [GraphQL](graphql.md) and [OpenAPI](swagger.md)
12+
Most modern API formats including [JSON-LD / Hydra](content-negotiation.md), [GraphQL](graphql.md) and [OpenAPI](openapi.md)
1313
allow you to mark resources types, operations or fields as deprecated.
1414

1515
## Deprecating Resource Classes, Operations and Properties

core/design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To do so, you have to write a plain old PHP object (POPO) representing the input
88
that is [marked with the `#[ApiResource]` attribute](../distribution/index.md).
99
This class **doesn't have** to be mapped with Doctrine ORM, or any other persistence system. It must be simple (it's usually
1010
just a data structure with no or minimal behaviors) and will be automatically converted to [Hydra](extending-jsonld-context.md),
11-
[OpenAPI](swagger.md) and [GraphQL](graphql.md) documentations or schemas by API Platform (there is a 1-1 mapping
11+
[OpenAPI](openapi.md) and [GraphQL](graphql.md) documentations or schemas by API Platform (there is a 1-1 mapping
1212
between this class and those docs).
1313

1414
Then, it's up to the developer to feed API Platform with an hydrated instance of this API resource object by implementing

core/extending.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Extending API Platform
22

3-
Because it handles the complex, tedious and repetitive task of creating an API infrastructure for you, API Platform lets you focus on what matter the most for the end user: the business logic.
3+
Because it handles the complex, tedious and repetitive task of creating an API infrastructure for you, API Platform lets you focus on what matters the most for the end user: the business logic.
44
To do so, API Platform provides a lot of extension points you can use to hook your own code.
55
Those extensions points are taken into account both by the REST and [GraphQL](graphql.md) subsystems.
66

core/external-vocabularies.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Using External Vocabularies
22

33
JSON-LD allows to define classes and properties of your API with open vocabularies such as [Schema.org](https://schema.org)
4-
and [Good Relations](http://www.heppnetz.de/projects/goodrelations/).
4+
and [Good Relations](https://www.heppnetz.de/projects/goodrelations/).
55

6-
API Platform provides annotations usable on PHP classes and properties for specifying a related external [IRI](https://en.wikipedia.org/wiki/Internationalized_resource_identifier).
6+
API Platform provides attributes usable on PHP classes and properties for specifying a related external [IRI](https://en.wikipedia.org/wiki/Internationalized_resource_identifier).
77

88
```php
99
<?php
@@ -25,7 +25,7 @@ class Book
2525
}
2626
```
2727

28-
The generated JSON for products and the related context document will now use external IRIs according to the specified annotations:
28+
The generated JSON for products and the related context document will now use external IRIs according to the specified attributes:
2929

3030
`GET /books/22`
3131

@@ -50,9 +50,9 @@ The generated JSON for products and the related context document will now use ex
5050
}
5151
```
5252

53-
An extended list of existing open vocabularies is available on [the Linked Open Vocabularies (LOV) database](http://lov.okfn.org/dataset/lov/).
53+
An extended list of existing open vocabularies is available on [the Linked Open Vocabularies (LOV) database](https://lov.linkeddata.es/dataset/lov/).
5454

55-
By default, when using [validations](validation.md) API Platform will try to define known [Schema.org](https://schema.org) types as IRIs for your properties if you did not provide any in your `#[ApiProperty]` annotations.
55+
By default, when using [validations](validation.md) API Platform will try to define known [Schema.org](https://schema.org) types as IRIs for your properties if you did not provide any in your `#[ApiProperty]` attributes.
5656
Built-in mapping is:
5757

5858
Constraints | Schema.org type |

core/filters.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ by the library.
99

1010
By default, all filters are disabled. They must be enabled explicitly.
1111

12-
When a filter is enabled, it automatically appears in the [OpenAPI](swagger.md) and [GraphQL](graphql.md) documentations.
12+
When a filter is enabled, it automatically appears in the [OpenAPI](openapi.md) and [GraphQL](graphql.md) documentations.
1313
It is also automatically documented as a `hydra:search` property for JSON-LD responses.
1414

1515
<p align="center" class="symfonycasts"><a href="https://symfonycasts.com/screencast/api-platform/filters?cid=apip"><img src="../distribution/images/symfonycasts-player.png" alt="Filtering and Searching screencast"><br>Watch the Filtering & Searching screencast</a>
@@ -1416,10 +1416,10 @@ class AndOperatorFilterExtension implements RequestBodySearchCollectionExtension
14161416

14171417
### Using Doctrine ORM Filters
14181418

1419-
Doctrine ORM features [a filter system](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/filters.html) that allows the developer to add SQL to the conditional clauses of queries, regardless of the place where the SQL is generated (e.g. from a DQL query, or by loading associated entities).
1419+
Doctrine ORM features [a filter system](https://www.doctrine-project.org/projects/doctrine-orm/en/latest/reference/filters.html) that allows the developer to add SQL to the conditional clauses of queries, regardless of the place where the SQL is generated (e.g. from a DQL query, or by loading associated entities).
14201420
These are applied to collections and items and therefore are incredibly useful.
14211421

1422-
The following information, specific to Doctrine filters in Symfony, is based upon [a great article posted on Michaël Perrin's blog](http://blog.michaelperrin.fr/2014/12/05/doctrine-filters/).
1422+
The following information, specific to Doctrine filters in Symfony, is based upon [a great article posted on Michaël Perrin's blog](https://www.michaelperrin.fr/blog/2014/12/doctrine-filters).
14231423

14241424
Suppose we have a `User` entity and an `Order` entity related to the `User` one. A user should only see his orders and no one else's.
14251425

core/getting-started.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ If you plan to migrate from FOSRestBundle, you might want to read [this guide](m
99
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).
1010
It comes with the API Platform core library integrated with [the Symfony framework](https://symfony.com), [the schema generator](../schema-generator/),
1111
[Doctrine ORM](https://www.doctrine-project.org), [Elasticsearch-PHP](https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/index.html),
12-
[NelmioCorsBundle](https://github.com/nelmio/NelmioCorsBundle) and [Behat](http://behat.org).
12+
[NelmioCorsBundle](https://github.com/nelmio/NelmioCorsBundle) and [Behat](https://behat.org/).
1313
[Doctrine MongoDB ODM](https://www.doctrine-project.org/projects/mongodb-odm.html) can also be enabled by following the [MongoDB documentation](mongodb.md).
1414
Basically, it is a Symfony edition packaged with the best tools to develop a REST API and sensible default settings.
1515

16-
Alternatively, you can use [Composer](http://getcomposer.org) to install the standalone bundle in an existing Symfony Flex
16+
Alternatively, you can use [Composer](https://getcomposer.org/) to install the standalone bundle in an existing Symfony Flex
1717
project:
1818

1919
`composer require api`
@@ -26,17 +26,17 @@ There are no mandatory configuration options although [many settings are availab
2626

2727
If you haven't read it already, take a look at [the Getting Started guide](../distribution/index.md).
2828
This tutorial covers basic concepts required to understand how API Platform works including how it implements the REST pattern
29-
and what [JSON-LD](http://json-ld.org/) and [Hydra](http://www.hydra-cg.com/) formats are.
29+
and what [JSON-LD](https://json-ld.org/) and [Hydra](https://www.hydra-cg.com/) formats are.
3030

3131
## Mapping the Entities
3232

3333
<p align="center" class="symfonycasts"><a href="https://symfonycasts.com/screencast/api-platform/api-resource?cid=apip"><img src="../distribution/images/symfonycasts-player.png" alt="Create an API Resource screencast"><br>Watch the Create an API Resource screencast</a></p>
3434

3535
API Platform is able to automatically expose entities mapped as "API resources" through a REST API supporting CRUD
3636
operations.
37-
To expose your entities, you can use Docblock annotations, XML and YAML configuration files.
37+
To expose your entities, you can use attributes, XML and YAML configuration files.
3838

39-
Here is an example of entities mapped using annotations which will be exposed through a REST API:
39+
Here is an example of entities mapped using attributes which will be exposed through a REST API:
4040

4141
```php
4242
<?php
@@ -139,8 +139,8 @@ class Offer
139139
It is the minimal configuration required to expose `Product` and `Offer` entities as JSON-LD documents through an hypermedia
140140
web API.
141141

142-
If you are familiar with the Symfony ecosystem, you noticed that entity classes are also mapped with Doctrine ORM annotations
143-
and validation constraints from [the Symfony Validator Component](http://symfony.com/doc/current/book/validation.html).
142+
If you are familiar with the Symfony ecosystem, you noticed that entity classes are also mapped with Doctrine ORM attributes
143+
and validation constraints from [the Symfony Validator Component](https://symfony.com/doc/current/validation.html).
144144
This isn't mandatory. You can use [your preferred persistence](state-providers.md) and [validation](validation.md) systems.
145145
However, API Platform has built-in support for those libraries and is able to use them without requiring any specific
146146
code or configuration to automatically persist and validate your data. They are a good default option and we encourage you to use
@@ -164,7 +164,7 @@ The same operations are available for the offer method (routes will start with t
164164
Route prefixes are built by pluralizing the name of the mapped entity class.
165165
It is also possible to override the naming convention using [operation path namings](operation-path-naming.md).
166166

167-
As an alternative to annotations, you can map entity classes using YAML or XML:
167+
As an alternative to attributes, you can map entity classes using YAML or XML:
168168

169169
[codeSelector]
170170

@@ -202,14 +202,14 @@ resources:
202202

203203
[/codeSelector]
204204

205-
If you prefer to use YAML or XML files instead of annotations, you must configure API Platform to load the appropriate files:
205+
If you prefer to use YAML or XML files instead of attributes, you must configure API Platform to load the appropriate files:
206206

207207
```yaml
208208
# api/config/packages/api_platform.yaml
209209
api_platform:
210210
mapping:
211211
paths:
212-
- '%kernel.project_dir%/src/Entity' # default configuration for annotations
212+
- '%kernel.project_dir%/src/Entity' # default configuration for attributes
213213
- '%kernel.project_dir%/config/api_platform' # yaml or xml directory configuration
214214
```
215215
@@ -220,6 +220,6 @@ If you want to serialize only a subset of your data, please refer to the [Serial
220220
You now have a fully featured API exposing your entities.
221221
Run the Symfony app with the [Symfony Local Web Server](https://symfony.com/doc/current/setup/symfony_server.html) (`symfony server:start`) and browse the API entrypoint at `http://localhost:8000/api`.
222222

223-
Interact with the API using a REST client (we recommend [Postman](https://www.getpostman.com/)) or an Hydra-aware application
223+
Interact with the API using a REST client (we recommend [Postman](https://www.postman.com/)) or an Hydra-aware application
224224
(you should give [Hydra Console](https://github.com/lanthaler/HydraConsole) a try). Take
225225
a look at the usage examples in [the `features` directory](https://github.com/api-platform/core/tree/main/features).

0 commit comments

Comments
 (0)