Skip to content

Commit f287be0

Browse files
dunglassoyuka
dunglas
and
soyuka
authored
doc: add README files for components (api-platform#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]>
1 parent 9a0afc9 commit f287be0

File tree

20 files changed

+238
-22
lines changed

20 files changed

+238
-22
lines changed

‎src/Doctrine/Common/README.md‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
# API Platform - Doctrine Common
1+
# API Platform - Doctrine Common Support
22

3-
Common files used by api-platform/doctrine-orm and api-platform/doctrine-odm
4-
5-
## Resources
3+
Integration for [Doctrine](https://www.doctrine-project.org) with the [API Platform](https://api-platform.com) framework.
64

5+
[Documentation](https://api-platform.com/docs/core/getting-started/)
76

7+
> [!CAUTION]
8+
>
9+
> This is a read-only sub split of `api-platform/core`, please
10+
> [report issues](https://github.com/api-platform/core/issues) and
11+
> [send Pull Requests](https://github.com/api-platform/core/pulls)
12+
> in the [core API Platform repository](https://github.com/api-platform/core).

‎src/Doctrine/Odm/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# API Platform - Doctrine MongoDB ODM Support
2+
3+
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.
4+
5+
[Documentation](https://api-platform.com/docs/core/mongodb/)
6+
7+
> [!CAUTION]
8+
>
9+
> This is a read-only sub split of `api-platform/core`, please
10+
> [report issues](https://github.com/api-platform/core/issues) and
11+
> [send Pull Requests](https://github.com/api-platform/core/pulls)
12+
> in the [core API Platform repository](https://github.com/api-platform/core).

‎src/Doctrine/Orm/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# API Platform - Doctrine ORM Support
2+
3+
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.
4+
5+
[Documentation](https://api-platform.com/docs/core/getting-started/)
6+
7+
> [!CAUTION]
8+
>
9+
> This is a read-only sub split of `api-platform/core`, please
10+
> [report issues](https://github.com/api-platform/core/issues) and
11+
> [send Pull Requests](https://github.com/api-platform/core/pulls)
12+
> in the [core API Platform repository](https://github.com/api-platform/core).

‎src/Documentation/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# API Platform - Documentation
2+
3+
The API documentation component of the [API Platform](https://api-platform.com) framework.
4+
5+
[Documentation](https://api-platform.com/docs/core/)
6+
7+
> [!CAUTION]
8+
>
9+
> This is a read-only sub split of `api-platform/core`, please
10+
> [report issues](https://github.com/api-platform/core/issues) and
11+
> [send Pull Requests](https://github.com/api-platform/core/pulls)
12+
> in the [core API Platform repository](https://github.com/api-platform/core).

‎src/Elasticsearch/README.md‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
# API Platform - Elasticsearch
1+
# API Platform - Elasticsearch Support
22

3-
Elasticsearch Support.
4-
5-
## Resources
3+
Integration for [Elasticsearch](https://www.elastic.co/elasticsearch) with the [API Platform](https://api-platform.com) framework.
64

5+
[Documentation](https://api-platform.com/docs/core/elasticsearch/)
76

7+
> [!CAUTION]
8+
>
9+
> This is a read-only sub split of `api-platform/core`, please
10+
> [report issues](https://github.com/api-platform/core/issues) and
11+
> [send Pull Requests](https://github.com/api-platform/core/pulls)
12+
> in the [core API Platform repository](https://github.com/api-platform/core).

‎src/GraphQl/README.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
11
# API Platform - GraphQL
22

3-
Build GraphQL API endpoints
3+
The [GraphQL](https://graphql.org/) component of the [API Platform](https://api-platform.com) framework.
4+
5+
[Documentation](https://api-platform.com/docs/core/graphql/)
6+
7+
> [!CAUTION]
8+
>
9+
> This is a read-only sub split of `api-platform/core`, please
10+
> [report issues](https://github.com/api-platform/core/issues) and
11+
> [send Pull Requests](https://github.com/api-platform/core/pulls)
12+
> in the [core API Platform repository](https://github.com/api-platform/core).

‎src/Hal/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# API Platform - HAL
2+
3+
The [HAL (Hypertext Application Language)](https://stateless.group/hal_specification.html) component of the [API Platform](https://api-platform.com) framework.
4+
5+
[Documentation](https://api-platform.com/docs/core/content-negotiation/)
6+
7+
> [!CAUTION]
8+
>
9+
> This is a read-only sub split of `api-platform/core`, please
10+
> [report issues](https://github.com/api-platform/core/issues) and
11+
> [send Pull Requests](https://github.com/api-platform/core/pulls)
12+
> in the [core API Platform repository](https://github.com/api-platform/core).

‎src/HttpCache/README.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
# API Platform - HTTP Cache
22

3-
HTTP Cache support.
3+
The [HTTP Cache](https://httpwg.org/specs/rfc7234.html) component of the [API Platform](https://api-platform.com) framework.
44

5-
## Resources
5+
This component also provides integrations with [Varnish](https://varnish-cache.org/), [Souin](https://souin.io/)
6+
and other HTTP cache servers and services.
67

8+
[Documentation](https://api-platform.com/docs/core/performance/)
79

10+
> [!CAUTION]
11+
>
12+
> This is a read-only sub split of `api-platform/core`, please
13+
> [report issues](https://github.com/api-platform/core/issues) and
14+
> [send Pull Requests](https://github.com/api-platform/core/pulls)
15+
> in the [core API Platform repository](https://github.com/api-platform/core).

‎src/Hydra/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# API Platform - Hydra
2+
3+
The [Hydra](https://www.hydra-cg.com/) component of the [API Platform](https://api-platform.com) framework.
4+
5+
Hydra simplifies the development of interoperable, hypermedia-driven Web APIs.
6+
7+
[Documentation](https://api-platform.com/docs/core/)
8+
9+
> [!CAUTION]
10+
>
11+
> This is a read-only sub split of `api-platform/core`, please
12+
> [report issues](https://github.com/api-platform/core/issues) and
13+
> [send Pull Requests](https://github.com/api-platform/core/pulls)
14+
> in the [core API Platform repository](https://github.com/api-platform/core).

‎src/JsonApi/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# API Platform - JSON:API
2+
3+
The [JSON:API](https://jsonapi.org/) component of the [API Platform](https://api-platform.com) framework.
4+
5+
JSON:API is a popular specification for building APIs in JSON.
6+
7+
[Documentation](https://api-platform.com/docs/core/content-negotiation/)
8+
9+
> [!CAUTION]
10+
>
11+
> This is a read-only sub split of `api-platform/core`, please
12+
> [report issues](https://github.com/api-platform/core/issues) and
13+
> [send Pull Requests](https://github.com/api-platform/core/pulls)
14+
> in the [core API Platform repository](https://github.com/api-platform/core).

0 commit comments

Comments
 (0)