Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit e2ec5ea

Browse files
lex111alanpoulain
authored andcommitted
Improve docs (#903)
* Improve docs * Replace nginx with NGINX
1 parent dee67c6 commit e2ec5ea

25 files changed

+35
-35
lines changed

‎admin/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
If you use the [API Platform Distribution](../distribution/), API Platform Admin is already installed, you can skip this installation guide.
66

7-
Otherwise, all you need to install API Platform Admin is a JavaScript package manager. We recommend [Yarn](https://yarnpkg.com/) ([NPM](https://www.npmjs.com/) is also supported).
7+
Otherwise, all you need to install API Platform Admin is a JavaScript package manager. We recommend [Yarn](https://yarnpkg.com/) ([npm](https://www.npmjs.com/) is also supported).
88

99
If you don't have an existing React Application, create one using [Create React App](https://create-react-app.dev/):
1010

‎client-generator/nextjs.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Create a [Next.js application with express server](https://github.com/zeit/next.
1616

1717
### Installing the Generator Dependencies
1818

19-
Enable Typescript in your next project
19+
Enable TypeScript in your next project
2020

2121
$ yarn add --dev typescript @types/react @types/node
2222

‎client-generator/react-native.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Install
66

7-
To use this generator you need [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) (or [NPM](https://www.npmjs.com/)) installed.
7+
To use this generator you need [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) (or [npm](https://www.npmjs.com/)) installed.
88
To run the command line tool, we also recommend using [npx](https://www.npmjs.com/package/npx).
99

1010
Create a React Native application using [Expo CLI](https://docs.expo.io/versions/latest/workflow/expo-cli).

‎client-generator/react.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ supporting Hydra.
2020

2121
If you use API Platform, jump to the next section!
2222
Alternatively, you can generate a skeleton and install the generator using [npx](https://www.npmjs.com/package/npx).
23-
To use this generator you need [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) (or [NPM](https://www.npmjs.com/)) installed.
23+
To use this generator you need [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) (or [npm](https://www.npmjs.com/)) installed.
2424

2525
Bootstrap a React application:
2626

@@ -92,7 +92,7 @@ ReactDOM.render(
9292
<ConnectedRouter history={history}>
9393
<Switch>
9494
{bookRoutes}
95-
{/* Replace bookRooutes with the name of the resource type */}
95+
{/* Replace bookRoutes with the name of the resource type */}
9696
<Route render={() => <h1>Not Found</h1>} />
9797
</Switch>
9898
</ConnectedRouter>

‎client-generator/typescript.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Typescript Interfaces
1+
# TypeScript Interfaces
22

33
The TypeScript Generator allows you to create [TypeScript interfaces](https://www.typescriptlang.org/docs/handbook/interfaces.html) that you can embed in any TypeScript-enabled project (React, Vue.js, Angular..)
44

‎core/data-persisters.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ classes called **data persisters**. Data persisters receive an instance of the c
55
the `@ApiResource` annotation). This instance contains data submitted by the client during [the deserialization
66
process](serialization.md).
77

8-
A data persister using [Doctrine ORM](http://www.doctrine-project.org/projects/orm.html) is included with the library and
8+
A data persister using [Doctrine ORM](https://www.doctrine-project.org/projects/orm.html) is included with the library and
99
is enabled by default. It is able to persist and delete objects that are also mapped as [Doctrine entities](https://www.doctrine-project.org/projects/doctrine-orm/en/current/reference/basic-mapping.html).
1010
A [Doctrine MongoDB ODM](https://www.doctrine-project.org/projects/mongodb-odm.html) data persister is also included and can be enabled by following the [MongoDB documentation](mongodb.md).
1111

‎core/data-providers.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Data Providers
22

33
To retrieve data exposed by the API, API Platform uses classes called **data providers**. A data provider using [Doctrine
4-
ORM](http://www.doctrine-project.org/projects/orm.html) to retrieve data from a database, a data provider using
4+
ORM](https://www.doctrine-project.org/projects/orm.html) to retrieve data from a database, a data provider using
55
[Doctrine MongoDB ODM](https://www.doctrine-project.org/projects/mongodb-odm.html) to retrieve data from a document
66
database, and a data provider using [Elasticsearch-PHP](https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/index.html)
77
to retrieve data from an Elasticsearch cluster are included with the library. The first one is enabled by default. These

‎core/deprecations.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ class Parchment
129129
}
130130
```
131131

132-
The value of the `sunset` attribute can be any string compatible with [the `\DateTime` constructor](http://php.net/manual/en/datetime.construct.php).
132+
The value of the `sunset` attribute can be any string compatible with [the `\DateTime` constructor](https://www.php.net/manual/en/datetime.construct.php).
133133
It will be automatically converted to a valid HTTP date.
134134

135135
It's also possible to set the `Sunset` header only for a specific [operation](operations.md):

‎core/design.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Last but not least, to create [Event Sourcing](https://martinfowler.com/eaaDev/E
4646
approach is:
4747

4848
* to persist data in an event store using a Messenger handler or a custom [data persister](data-persisters.md)
49-
* to create projections in standard RDBMS (Postgres, MariaDB...) tables or views
49+
* to create projections in standard RDBMS (PostgreSQL, MariaDB...) tables or views
5050
* to map those projections with read-only Doctrine entity classes **and** to mark those classes with `@ApiResource`
5151

5252
You can then benefit from the built-in Doctrine filters, sorting, pagination, auto-joins and all of [the extension points](extending.md) provided by API Platform.

‎core/errors.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
API Platform comes with a powerful error system. It handles expected (such as faulty JSON documents sent by the
44
client or validation errors) as well as unexpected errors (PHP exceptions and errors).
55
API Platform automatically sends the appropriate HTTP status code to the client: `400` for expected errors, `500` for
6-
unexpected ones. It also provides a description of the error in [the Hydra error format](http://www.hydra-cg.com/spec/latest/core/#description-of-http-status-codes-and-errors)
6+
unexpected ones. It also provides a description of the error in [the Hydra error format](https://www.hydra-cg.com/spec/latest/core/#description-of-http-status-codes-and-errors)
77
or in the format described in the [RFC 7807](https://tools.ietf.org/html/rfc7807), depending of the format selected during the [content negotiation](content-negotiation.md).
88

99
## Converting PHP Exceptions to HTTP Errors

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /