-
-
Notifications
You must be signed in to change notification settings - Fork 874
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add README files for components (#6653)
* docs: add README for components * Update README.md Co-authored-by: Antoine Bluchet <[email protected]> * Update README.md Co-authored-by: Antoine Bluchet <[email protected]> * Update README.md Co-authored-by: Antoine Bluchet <[email protected]> * remove trailing spaces * typo * better title --------- Co-authored-by: Antoine Bluchet <[email protected]>
- Loading branch information
Showing
20 changed files
with
238 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,12 @@ | ||
| # API Platform - Doctrine Common | ||
| # API Platform - Doctrine Common Support | ||
|
|
||
| Common files used by api-platform/doctrine-orm and api-platform/doctrine-odm | ||
|
|
||
| ## Resources | ||
| Integration for [Doctrine](https://www.doctrine-project.org) with the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/getting-started/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # API Platform - Doctrine MongoDB ODM Support | ||
|
|
||
| Integration for [Doctrine MongoDB ODM](https://www.doctrine-project.org/projects/doctrine-mongodb-odm/en/current/index.html) with the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/mongodb/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # API Platform - Doctrine ORM Support | ||
|
|
||
| Integration for [Doctrine ORM](https://www.doctrine-project.org/projects/doctrine-orm/en/current/index.html) with the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/getting-started/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # API Platform - Documentation | ||
|
|
||
| The API documentation component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,12 @@ | ||
| # API Platform - Elasticsearch | ||
| # API Platform - Elasticsearch Support | ||
|
|
||
| Elasticsearch Support. | ||
|
|
||
| ## Resources | ||
| Integration for [Elasticsearch](https://www.elastic.co/elasticsearch) with the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/elasticsearch/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,12 @@ | ||
| # API Platform - GraphQL | ||
|
|
||
| Build GraphQL API endpoints | ||
| The [GraphQL](https://graphql.org/) component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/graphql/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # API Platform - HAL | ||
|
|
||
| The [HAL (Hypertext Application Language)](https://stateless.group/hal_specification.html) component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/content-negotiation/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,15 @@ | ||
| # API Platform - HTTP Cache | ||
|
|
||
| HTTP Cache support. | ||
| The [HTTP Cache](https://httpwg.org/specs/rfc7234.html) component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| ## Resources | ||
| This component also provides integrations with [Varnish](https://varnish-cache.org/), [Souin](https://souin.io/) | ||
| and other HTTP cache servers and services. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/performance/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # API Platform - Hydra | ||
|
|
||
| The [Hydra](https://www.hydra-cg.com/) component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| Hydra simplifies the development of interoperable, hypermedia-driven Web APIs. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # API Platform - JSON:API | ||
|
|
||
| The [JSON:API](https://jsonapi.org/) component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| JSON:API is a popular specification for building APIs in JSON. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/content-negotiation/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # API Platform - JSON-LD | ||
|
|
||
| The [JSON-LD](https://json-ld.org/) component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| Data is messy and disconnected. JSON-LD organizes and connects it, creating a better Web. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/extending-jsonld-context/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,14 @@ | ||
| # API Platform - JSON Schema | ||
|
|
||
| Build a JSON Schema from API Resources. | ||
| The [JSON Schema](https://json-schema.org/) component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| ## Resources | ||
| Generates JSON Schema from PHP classes. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/json-schema/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # API Platform - Metadata | ||
|
|
||
| The Metadata component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| Generates abstract representation of web APIs. It's the core of the API Platform Core library. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,14 @@ | ||
| # API Platform - OpenAPI | ||
|
|
||
| Models to build and serialize an OpenAPI specification. | ||
| The [OpenAPI](https://www.openapis.org) component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| ## Resources | ||
| Builds and serializes OpenAPI specifications. OpenAPI was formerly known as Swagger. | ||
|
|
||
| - [Documentation](https://api-platform.com/docs) | ||
| - [Report issues](https://github.com/api-platform/core/issues) and [send Pull Requests](https://github.com/api-platform/core/pulls) on the [main API Platform repository](https://github.com/api-platform/core) | ||
| [Documentation](https://api-platform.com/docs/core/openapi/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,17 @@ | ||
| # API Platform - Parameter Validator | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This package has been **deprecated** and doesn't exist anymore in API Platform 4. | ||
| > Use [the Metadata package](https://github.com/api-platform/metadata) instead. | ||
| The Parameter Validator component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/filters/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,12 @@ | ||
| # API Platform - RamseyUuid | ||
| # API Platform - `ramsey/uuid | ||
|
|
||
| RamseyUuid component from API Platform | ||
| Integration for [`ramsey/uuid`](https://uuid.ramsey.dev) with the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/identifiers/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,15 @@ | ||
| # API Platform - Serializer | ||
|
|
||
| The API Platform Serializer | ||
| The Serializer component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| Serializes PHP objects in various API formats. | ||
| Built on top of the Symfony Serializer component. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/core/serialization/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # API Platform - Serializer | ||
|
|
||
| The State component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| Provides and processes API states. | ||
|
|
||
| Documentation: | ||
|
|
||
| * [State providers](https://api-platform.com/docs/core/state-providers/) | ||
| * [State processors](https://api-platform.com/docs/core/state-processors/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,12 @@ | ||
| # API Platform - Symfony | ||
| # API Platform for Symfony | ||
|
|
||
| Integration of [Symfony](https://symfony.com) with the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/symfony/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,12 @@ | ||
| # API Platform - Validator | ||
|
|
||
| Validator component from API Platform | ||
| The Validator component of the [API Platform](https://api-platform.com) framework. | ||
|
|
||
| [Documentation](https://api-platform.com/docs/admin/validation/) | ||
|
|
||
| > [!CAUTION] | ||
| > | ||
| > This is a read-only sub split of `api-platform/core`, please | ||
| > [report issues](https://github.com/api-platform/core/issues) and | ||
| > [send Pull Requests](https://github.com/api-platform/core/pulls) | ||
| > in the [core API Platform repository](https://github.com/api-platform/core). |