From 70b40687f381ff386b09d1e45ccf0c673bff82c6 Mon Sep 17 00:00:00 2001 From: Alexey Pyltsyn Date: Wed, 2 Oct 2019 00:05:28 +0300 Subject: [PATCH 1/2] Improve docs --- admin/getting-started.md | 2 +- client-generator/nextjs.md | 2 +- client-generator/react-native.md | 2 +- client-generator/react.md | 4 ++-- client-generator/typescript.md | 2 +- core/data-persisters.md | 2 +- core/data-providers.md | 2 +- core/deprecations.md | 2 +- core/design.md | 2 +- core/errors.md | 2 +- core/external-vocabularies.md | 2 +- core/filters.md | 2 +- core/getting-started.md | 2 +- core/graphql.md | 2 +- core/index.md | 2 +- core/pagination.md | 2 +- core/swagger.md | 6 +++--- core/testing.md | 2 +- core/validation.md | 4 ++-- deployment/heroku.md | 2 +- distribution/index.md | 6 +++--- extra/philosophy.md | 4 ++-- extra/troubleshooting.md | 2 +- schema-generator/getting-started.md | 2 +- schema-generator/index.md | 4 ++-- 25 files changed, 33 insertions(+), 33 deletions(-) diff --git a/admin/getting-started.md b/admin/getting-started.md index e390b432e2f..15b27e4b03b 100644 --- a/admin/getting-started.md +++ b/admin/getting-started.md @@ -4,7 +4,7 @@ If you use the [API Platform Distribution](../distribution/), API Platform Admin is already installed, you can skip this installation guide. -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). +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). If you don't have an existing React Application, create one using [Create React App](https://create-react-app.dev/): diff --git a/client-generator/nextjs.md b/client-generator/nextjs.md index 65db7df8bfa..776e8e1c19c 100644 --- a/client-generator/nextjs.md +++ b/client-generator/nextjs.md @@ -16,7 +16,7 @@ Create a [Next.js application with express server](https://github.com/zeit/next. ### Installing the Generator Dependencies -Enable Typescript in your next project +Enable TypeScript in your next project $ yarn add --dev typescript @types/react @types/node diff --git a/client-generator/react-native.md b/client-generator/react-native.md index dd212c6d393..c5dba9bd9d2 100644 --- a/client-generator/react-native.md +++ b/client-generator/react-native.md @@ -4,7 +4,7 @@ ## Install -To use this generator you need [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) (or [NPM](https://www.npmjs.com/)) installed. +To use this generator you need [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) (or [npm](https://www.npmjs.com/)) installed. To run the command line tool, we also recommend using [npx](https://www.npmjs.com/package/npx). Create a React Native application using [Expo CLI](https://docs.expo.io/versions/latest/workflow/expo-cli). diff --git a/client-generator/react.md b/client-generator/react.md index 795e375fb28..1850886d834 100644 --- a/client-generator/react.md +++ b/client-generator/react.md @@ -20,7 +20,7 @@ supporting Hydra. If you use API Platform, jump to the next section! Alternatively, you can generate a skeleton and install the generator using [npx](https://www.npmjs.com/package/npx). -To use this generator you need [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) (or [NPM](https://www.npmjs.com/)) installed. +To use this generator you need [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) (or [npm](https://www.npmjs.com/)) installed. Bootstrap a React application: @@ -92,7 +92,7 @@ ReactDOM.render( {bookRoutes} - {/* Replace bookRooutes with the name of the resource type */} + {/* Replace bookRoutes with the name of the resource type */}

Not Found

} /> diff --git a/client-generator/typescript.md b/client-generator/typescript.md index 7f99b734c0b..e7b75e0c330 100644 --- a/client-generator/typescript.md +++ b/client-generator/typescript.md @@ -1,4 +1,4 @@ -# Typescript Interfaces +# TypeScript Interfaces 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..) diff --git a/core/data-persisters.md b/core/data-persisters.md index 4364855a035..113277ff489 100644 --- a/core/data-persisters.md +++ b/core/data-persisters.md @@ -5,7 +5,7 @@ classes called **data persisters**. Data persisters receive an instance of the c the `@ApiResource` annotation). This instance contains data submitted by the client during [the deserialization process](serialization.md). -A data persister using [Doctrine ORM](http://www.doctrine-project.org/projects/orm.html) is included with the library and +A data persister using [Doctrine ORM](https://www.doctrine-project.org/projects/orm.html) is included with the library and 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). 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). diff --git a/core/data-providers.md b/core/data-providers.md index 690731d9819..958487de1b1 100644 --- a/core/data-providers.md +++ b/core/data-providers.md @@ -1,7 +1,7 @@ # Data Providers To retrieve data exposed by the API, API Platform uses classes called **data providers**. A data provider using [Doctrine -ORM](http://www.doctrine-project.org/projects/orm.html) to retrieve data from a database, a data provider using +ORM](https://www.doctrine-project.org/projects/orm.html) to retrieve data from a database, a data provider using [Doctrine MongoDB ODM](https://www.doctrine-project.org/projects/mongodb-odm.html) to retrieve data from a document database, and a data provider using [Elasticsearch-PHP](https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/index.html) to retrieve data from an Elasticsearch cluster are included with the library. The first one is enabled by default. These diff --git a/core/deprecations.md b/core/deprecations.md index fe2efa1814a..1707988694e 100644 --- a/core/deprecations.md +++ b/core/deprecations.md @@ -129,7 +129,7 @@ class Parchment } ``` -The value of the `sunset` attribute can be any string compatible with [the `\DateTime` constructor](http://php.net/manual/en/datetime.construct.php). +The value of the `sunset` attribute can be any string compatible with [the `\DateTime` constructor](https://www.php.net/manual/en/datetime.construct.php). It will be automatically converted to a valid HTTP date. It's also possible to set the `Sunset` header only for a specific [operation](operations.md): diff --git a/core/design.md b/core/design.md index d67a2b81f11..0efba66d5f3 100644 --- a/core/design.md +++ b/core/design.md @@ -46,7 +46,7 @@ Last but not least, to create [Event Sourcing](https://martinfowler.com/eaaDev/E approach is: * to persist data in an event store using a Messenger handler or a custom [data persister](data-persisters.md) -* to create projections in standard RDBMS (Postgres, MariaDB...) tables or views +* to create projections in standard RDBMS (PostgreSQL, MariaDB...) tables or views * to map those projections with read-only Doctrine entity classes **and** to mark those classes with `@ApiResource` 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. diff --git a/core/errors.md b/core/errors.md index 231fa785599..297d47e53e9 100644 --- a/core/errors.md +++ b/core/errors.md @@ -3,7 +3,7 @@ API Platform comes with a powerful error system. It handles expected (such as faulty JSON documents sent by the client or validation errors) as well as unexpected errors (PHP exceptions and errors). API Platform automatically sends the appropriate HTTP status code to the client: `400` for expected errors, `500` for -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) +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) 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). ## Converting PHP Exceptions to HTTP Errors diff --git a/core/external-vocabularies.md b/core/external-vocabularies.md index 2a4add28a98..dd0ae593ca6 100644 --- a/core/external-vocabularies.md +++ b/core/external-vocabularies.md @@ -3,7 +3,7 @@ JSON-LD allows to define classes and properties of your API with open vocabularies such as [Schema.org](https://schema.org) and [Good Relations](http://www.heppnetz.de/projects/goodrelations/). -API Platform Core provides annotations usable on PHP classes and properties for specifying a related external [IRI](http://en.wikipedia.org/wiki/Internationalized_resource_identifier). +API Platform Core provides annotations usable on PHP classes and properties for specifying a related external [IRI](https://en.wikipedia.org/wiki/Internationalized_resource_identifier). ```php ]=value` -The value can take any date format supported by the [`\DateTime` constructor](http://php.net/manual/en/datetime.construct.php). +The value can take any date format supported by the [`\DateTime` constructor](https://www.php.net/manual/en/datetime.construct.php). The `after` and `before` filters will filter including the value whereas `strictly_after` and `strictly_before` will filter excluding the value. diff --git a/core/getting-started.md b/core/getting-started.md index caeabee6605..abf81801eba 100644 --- a/core/getting-started.md +++ b/core/getting-started.md @@ -4,7 +4,7 @@ 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). It comes with the API Platform Core library integrated with [the Symfony framework](https://symfony.com), [the schema generator](../schema-generator/), -[Doctrine ORM](http://www.doctrine-project.org), [Elasticsearch-PHP](https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/index.html), +[Doctrine ORM](https://www.doctrine-project.org), [Elasticsearch-PHP](https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/index.html), [NelmioCorsBundle](https://github.com/nelmio/NelmioCorsBundle) and [Behat](http://behat.org). [Doctrine MongoDB ODM](https://www.doctrine-project.org/projects/mongodb-odm.html) can also be enabled by following the [MongoDB documentation](mongodb.md). Basically, it is a Symfony edition packaged with the best tools to develop a REST API and sensible default settings. diff --git a/core/graphql.md b/core/graphql.md index 463d331c617..8727e8fff54 100644 --- a/core/graphql.md +++ b/core/graphql.md @@ -1,6 +1,6 @@ # GraphQL Support -[GraphQL](http://graphql.org/) is a query language made to communicate with an API and therefore is an alternative to REST. +[GraphQL](https://graphql.org/) is a query language made to communicate with an API and therefore is an alternative to REST. It has some advantages compared to REST: it solves the over-fetching or under-fetching of data, is strongly typed, and is capable of retrieving multiple and nested data in one go, but it also comes with drawbacks. For example it creates overhead depending on the request. diff --git a/core/index.md b/core/index.md index 2406a390985..54f250e5aff 100644 --- a/core/index.md +++ b/core/index.md @@ -1,6 +1,6 @@ # The API Platform Core Library -API Platform Core is an easy-to-use and powerful library to create [hypermedia-driven REST APIs](http://en.wikipedia.org/wiki/HATEOAS). +API Platform Core is an easy-to-use and powerful library to create [hypermedia-driven REST APIs](https://en.wikipedia.org/wiki/HATEOAS). It is a component of the [API Platform framework](https://api-platform.com). It can be used as a standalone or with [the Symfony framework](https://symfony.com) (recommended). diff --git a/core/pagination.md b/core/pagination.md index c915af65921..37e5c2958de 100644 --- a/core/pagination.md +++ b/core/pagination.md @@ -109,7 +109,7 @@ The pagination can now be enabled or disabled by adding a query parameter named * `GET /books?pagination=false`: disabled * `GET /books?pagination=true`: enabled -Any value accepted by the [`FILTER_VALIDATE_BOOLEAN`](http://php.net/manual/en/filter.filters.validate.php) filter can be +Any value accepted by the [`FILTER_VALIDATE_BOOLEAN`](https://www.php.net/manual/en/filter.filters.validate.php) filter can be used as the value. #### For a specific resource diff --git a/core/swagger.md b/core/swagger.md index 5a319b97a4e..685507052ab 100644 --- a/core/swagger.md +++ b/core/swagger.md @@ -84,7 +84,7 @@ final class SwaggerDecorator implements NormalizerInterface $docs['paths']['/foos']['get']['parameters'][] = $customDefinition; // e.g. remove an existing parameter - $docs['paths']['/foos']['get']['parameters'] = array_values(array_filter($docs['paths']['/foos']['get']['parameters'], function ($param){ + $docs['paths']['/foos']['get']['parameters'] = array_values(array_filter($docs['paths']['/foos']['get']['parameters'], function ($param) { return $param['name'] !== 'bar'; })); @@ -344,7 +344,7 @@ or with XML: ``` -![Impact on swagger ui](../distribution/images/swagger-ui-2.png) +![Impact on Swagger UI](../distribution/images/swagger-ui-2.png) Again, you can use the `openapi_context` key instead of the `swagger_context` one to tweak the OpenAPI **v3** specification. @@ -390,7 +390,7 @@ As described [in the Symfony documentation](https://symfony.com/doc/current/temp You may want to copy the [one shipped with API Platform](https://github.com/api-platform/core/blob/master/src/Bridge/Symfony/Bundle/Resources/views/SwaggerUi/index.html.twig) and customize it. -## Compatibilily Layer with Amazon API Gateway +## Compatibility Layer with Amazon API Gateway [AWS API Gateway](https://aws.amazon.com/api-gateway/) supports OpenAPI partially, but it [requires some changes](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.html). Fortunately, API Platform provides a way to be compatible with Amazon API Gateway. diff --git a/core/testing.md b/core/testing.md index 19e2ba38faa..fca7767a95c 100644 --- a/core/testing.md +++ b/core/testing.md @@ -43,7 +43,7 @@ Refer to [the Symfony HttpClient documentation](https://symfony.com/doc/current/ ## API Test Assertions -In addition to [the built-in ones](https://phpunit.readthedocs.io/fr/latest/assertions.html), API Platform provides convenient PHPUnit assertions dedicated to API testing: +In addition to [the built-in ones](https://phpunit.readthedocs.io/en/latest/assertions.html), API Platform provides convenient PHPUnit assertions dedicated to API testing: ```php Validation screencast
Watch the Validation screencast

@@ -235,7 +235,7 @@ With this configuration, there are three validation groups: ## Dynamic Validation Groups If you need to dynamically determine which validation groups to use for an entity in different scenarios, just pass in a -[callable](http://php.net/manual/en/language.types.callable.php). The callback will receive the entity object as its first +[callable](https://www.php.net/manual/en/language.types.callable.php). The callback will receive the entity object as its first argument, and should return an array of group names or a [group sequence](http://symfony.com/doc/current/validation/sequence_provider.html). In the following example, we use a static method to return the validation groups: diff --git a/deployment/heroku.md b/deployment/heroku.md index c8627453752..b44ccf77eac 100644 --- a/deployment/heroku.md +++ b/deployment/heroku.md @@ -1,6 +1,6 @@ # Deploying an API Platform App on Heroku -[Heroku](http://heroku.com) is a popular, fast, scalable and reliable *Platform As A Service* (PaaS). As Heroku offers a +[Heroku](https://www.heroku.com) is a popular, fast, scalable and reliable *Platform As A Service* (PaaS). As Heroku offers a free plan including database support through [Heroku Postgres](https://www.heroku.com/postgres), it's a convenient way to experiment with API Platform. diff --git a/distribution/index.md b/distribution/index.md index ba535107f6d..f90816e047f 100644 --- a/distribution/index.md +++ b/distribution/index.md @@ -98,7 +98,7 @@ you'll got auto-completion for almost everything and awesome quality analysis. The API Platform distribution comes with a dummy entity for test purpose: `api/src/Entity/Greeting.php`. We will remove it later. -If you're used to the PHP ecosystem, you probably guessed that this test entity uses the industry-leading [Doctrine ORM](http://www.doctrine-project.org/projects/orm.html) +If you're used to the PHP ecosystem, you probably guessed that this test entity uses the industry-leading [Doctrine ORM](https://www.doctrine-project.org/projects/orm.html) library as persistence system. It is shipped, in the API Platform distribution. Doctrine ORM is the easiest way to persist and query data in an API Platform project thanks to the bridge shipped with the distribution. It is optimized for performance and development convenience. For instance, when using Doctrine, API Platform @@ -143,7 +143,7 @@ And start the built-in PHP server: $ php -S 127.0.0.1:8000 -t public All JavaScript components are also [available as standalone libraries](https://github.com/api-platform?language=javascript) -installable with NPM or Yarn. +installable with npm or Yarn. **Note:** when installing API Platform this way, the API will be exposed as the `/api/` path. You need to open `http://localhost:8000/api/` to see the API documentation. If you are deploying API Platform directly on an Apache or Nginx webserver and getting a 404 error on opening this link, you will need to enable the [rewriting rules](https://symfony.com/doc/current/setup/web_server_configuration.html) for your specific webserver software. @@ -482,7 +482,7 @@ By the way, you may want to [embed documents](../core/serialization.md) instead (e.g. to reduce the number of HTTP requests). You can even [let the client select only the properties it needs](../core/filters.md#property-filter). The other interesting thing is how API Platform handles dates (the `publicationDate` property). API Platform understands -[any date format supported by PHP](http://php.net/manual/en/datetime.formats.date.php). In production we strongly recommend +[any date format supported by PHP](https://www.php.net/manual/en/datetime.formats.date.php). In production we strongly recommend using the format specified by the [RFC 3339](http://tools.ietf.org/html/rfc3339), but, as you can see, most common formats including `September 21, 2016` can be used. diff --git a/extra/philosophy.md b/extra/philosophy.md index 7e8a98de511..dafada6b91c 100644 --- a/extra/philosophy.md +++ b/extra/philosophy.md @@ -6,12 +6,12 @@ In 20 years of PHP, the web changed dramatically and is now evolving faster than and thanks to awesome frontend technologies such as [AngularJS](http://angularjs.org/) or [React](https://facebook.github.io/react/), [full-Javascript](https://en.wikipedia.org/wiki/Single-page_application) **webapps are becoming the standard**. * [Since 2014 internet users spend more time on their mobile devices than on desktops](http://techcrunch.com/2014/08/21/majority-of-digital-media-consumption-now-takes-place-in-mobile-apps/): having a responsive website is mandatory and **native mobile apps are a must-have**. -* [The semantic web](https://en.wikipedia.org/wiki/Semantic_Web) and **especially [Linked Data](http://en.wikipedia.org/wiki/Linked_data) +* [The semantic web](https://en.wikipedia.org/wiki/Semantic_Web) and **especially [Linked Data](https://en.wikipedia.org/wiki/Linked_data) is a reality**: with the [Schema.org](http://schema.org/) initiative and new open web standards such as [JSON-LD](http://json-ld.org/), search engines (among a bunch of other services and softwares) consume structured and machine-readable data at web scale. Not exposing such data decrease interoperability and search engine ranking/efficiency (think rich snippets). -[PHP.net](http://php.net), [Symfony](https://symfony.com), [Facebook](http://hhvm.com/) and many others have worked hard +[PHP.net](https://www.php.net), [Symfony](https://symfony.com), [Facebook](http://hhvm.com/) and many others have worked hard to improve and professionalize the PHP ecosystem. The PHP world has closed the gap with most backend solutions and is often more innovative than them. diff --git a/extra/troubleshooting.md b/extra/troubleshooting.md index 1b07c83bd2a..c6635c746ef 100644 --- a/extra/troubleshooting.md +++ b/extra/troubleshooting.md @@ -43,7 +43,7 @@ The JMS Serializer service is available as `jms_serializer`. Some of your API calls fail with a 502 error and the logs for the api container shows the following error message `upstream sent too big header while reading response header from upstream`. -This can be due to the cache invalidation headers that are too big for NGINX. When you query the API, API Platform adds the ids of all returned entities and their dependencies in the headers like so : `Cache-Tags: /entity/1,/dependent_entity/1,/entity/2`. This can overflow the default header size (4k) when your API gets larger and more complex. +This can be due to the cache invalidation headers that are too big for Nginx. When you query the API, API Platform adds the ids of all returned entities and their dependencies in the headers like so : `Cache-Tags: /entity/1,/dependent_entity/1,/entity/2`. This can overflow the default header size (4k) when your API gets larger and more complex. You can modify the `api/docker/nginx/conf.d/default.conf` file and set values to `fastcgi_buffer_size` and `fastcgi_buffers` that suit your needs, like so: diff --git a/schema-generator/getting-started.md b/schema-generator/getting-started.md index 0127f6ba846..7582c7ceea2 100644 --- a/schema-generator/getting-started.md +++ b/schema-generator/getting-started.md @@ -220,7 +220,7 @@ class PostalAddress private $id; /** - * @var string|null The country. For example, USA. You can also provide the two-letter \[ISO 3166-1 alpha-2 country code\](http://en.wikipedia.org/wiki/ISO\_3166-1). + * @var string|null The country. For example, USA. You can also provide the two-letter \[ISO 3166-1 alpha-2 country code\](https://en.wikipedia.org/wiki/ISO\_3166-1). * * @ORM\Column(type="text", nullable=true) * @ApiProperty(iri="http://schema.org/addressCountry") diff --git a/schema-generator/index.md b/schema-generator/index.md index de100da135b..ba42676ded6 100644 --- a/schema-generator/index.md +++ b/schema-generator/index.md @@ -27,8 +27,8 @@ or any other framework including [Laravel](http://laravel.com) and [Zend Framewo ## What Is Schema.org? -Schema.org is a vocabulary representing common data structures and their relations. Schema.org can be exposed as [JSON-LD](http://en.wikipedia.org/wiki/JSON-LD), -[microdata](https://en.wikipedia.org/wiki/Microdata_(HTML)) and [RDFa](http://en.wikipedia.org/wiki/RDFa). +Schema.org is a vocabulary representing common data structures and their relations. Schema.org can be exposed as [JSON-LD](https://en.wikipedia.org/wiki/JSON-LD), +[microdata](https://en.wikipedia.org/wiki/Microdata_(HTML)) and [RDFa](https://en.wikipedia.org/wiki/RDFa). Extracting semantical data exposed in the Schema.org vocabulary is supported by a growing number of companies including Google (Search, Gmail), Yahoo!, Bing and Yandex. From 448609815a5bd2463ffe3649dc51c87bf4370061 Mon Sep 17 00:00:00 2001 From: Alexey Pyltsyn Date: Wed, 2 Oct 2019 10:16:52 +0300 Subject: [PATCH 2/2] Replace nginx with NGINX --- deployment/kubernetes.md | 2 +- distribution/index.md | 4 ++-- extra/troubleshooting.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/deployment/kubernetes.md b/deployment/kubernetes.md index 252e68667ac..e230aad9fc2 100644 --- a/deployment/kubernetes.md +++ b/deployment/kubernetes.md @@ -16,7 +16,7 @@ package manager) chart to deploy in a wink on any of these platforms. ## Creating and Publishing the Docker Images -1. Build the PHP and Nginx Docker images: +1. Build the PHP and NGINX Docker images: docker build -t gcr.io/test-api-platform/php -t gcr.io/test-api-platform/php:latest api --target api_platform_php docker build -t gcr.io/test-api-platform/nginx -t gcr.io/test-api-platform/nginx:latest api --target api_platform_nginx diff --git a/distribution/index.md b/distribution/index.md index f90816e047f..f6da19f1d5f 100644 --- a/distribution/index.md +++ b/distribution/index.md @@ -79,7 +79,7 @@ This starts the following services: | db | A PostgreSQL database server | 5432 | all (prefer using a managed service in prod) | | client | A development server for the Progressive Web App | 80 | dev (use a static website hosting service in prod) | | admin | A development server for the admin | 81 | dev (use a static website hosting service in prod) | -| api | The HTTP server for the API (Nginx) | 8080 | all | +| api | The HTTP server for the API (NGINX) | 8080 | all | | mercure | The Mercure hub, [for real-time capabilities](../core/mercure.md) | 1337 | all (prefer using the managed version in prod) | | h2-proxy | A HTTP/2 and HTTPS development proxy for all apps | 443 (client)
444 (admin)
8443 (api)
1338 (mercure) | dev (configure properly your web server in prod) | @@ -145,7 +145,7 @@ And start the built-in PHP server: All JavaScript components are also [available as standalone libraries](https://github.com/api-platform?language=javascript) installable with npm or Yarn. -**Note:** when installing API Platform this way, the API will be exposed as the `/api/` path. You need to open `http://localhost:8000/api/` to see the API documentation. If you are deploying API Platform directly on an Apache or Nginx webserver and getting a 404 error on opening this link, you will need to enable the [rewriting rules](https://symfony.com/doc/current/setup/web_server_configuration.html) for your specific webserver software. +**Note:** when installing API Platform this way, the API will be exposed as the `/api/` path. You need to open `http://localhost:8000/api/` to see the API documentation. If you are deploying API Platform directly on an Apache or NGINX webserver and getting a 404 error on opening this link, you will need to enable the [rewriting rules](https://symfony.com/doc/current/setup/web_server_configuration.html) for your specific webserver software. ## It's Ready! diff --git a/extra/troubleshooting.md b/extra/troubleshooting.md index c6635c746ef..1b07c83bd2a 100644 --- a/extra/troubleshooting.md +++ b/extra/troubleshooting.md @@ -43,7 +43,7 @@ The JMS Serializer service is available as `jms_serializer`. Some of your API calls fail with a 502 error and the logs for the api container shows the following error message `upstream sent too big header while reading response header from upstream`. -This can be due to the cache invalidation headers that are too big for Nginx. When you query the API, API Platform adds the ids of all returned entities and their dependencies in the headers like so : `Cache-Tags: /entity/1,/dependent_entity/1,/entity/2`. This can overflow the default header size (4k) when your API gets larger and more complex. +This can be due to the cache invalidation headers that are too big for NGINX. When you query the API, API Platform adds the ids of all returned entities and their dependencies in the headers like so : `Cache-Tags: /entity/1,/dependent_entity/1,/entity/2`. This can overflow the default header size (4k) when your API gets larger and more complex. You can modify the `api/docker/nginx/conf.d/default.conf` file and set values to `fastcgi_buffer_size` and `fastcgi_buffers` that suit your needs, like so: