test/apisix
1
0
Fork 0
mirror of https://gitee.com/iresty/apisix.git synced 2024-12-04 13:07:34 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add GraphQL support to readme (#4450)

Browse Source 
Co-authored-by: 琚致远 <juzhiyuan@apache.org>
Co-authored-by: 罗泽轩 <spacewanderlzx@gmail.com>
This commit is contained in:
liuxiran 2021-06-21 15:18:09 +08:00 committed by GitHub
parent 8b2d29e7ff
commit 5162d7385e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -98,6 +98,7 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
- Support [TTL](docs/en/latest/admin-api.md#route) - Support [TTL](docs/en/latest/admin-api.md#route)
- [Support priority](docs/en/latest/router-radixtree.md#3-match-priority) - [Support priority](docs/en/latest/router-radixtree.md#3-match-priority)
- [Support Batch Http Requests](docs/en/latest/plugins/batch-requests.md) - [Support Batch Http Requests](docs/en/latest/plugins/batch-requests.md)
- [Support filtering route by GraphQL attributes](docs/en/latest/router-radixtree.md#how-to-filter-route-by-graphql-attributes)
- **Security** - **Security**

10
docs/en/latest/router-radixtree.md
View File

@ -218,15 +218,15 @@ $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f
This route will require the request header `host` equal `iresty.com`, request cookie key `_device_id` equal `a66f0cdc4ba2df8c096f74c9110163a9` etc. This route will require the request header `host` equal `iresty.com`, request cookie key `_device_id` equal `a66f0cdc4ba2df8c096f74c9110163a9` etc.
### How to filter route by graphql attributes ### How to filter route by GraphQL attributes
APISIX supports filtering route by some attributes of graphql. Currently we support: APISIX supports filtering route by some attributes of GraphQL. Currently we support:
* graphql_operation * graphql_operation
* graphql_name * graphql_name
* graphql_root_fields * graphql_root_fields
For instance, with graphql like this: For instance, with GraphQL like this:
```graphql ```graphql
query getRepo { query getRepo {
@ -264,7 +264,7 @@ $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f
}' }'
``` ```
To prevent spending too much time reading invalid graphql request body, we only read the first 1 MiB To prevent spending too much time reading invalid GraphQL request body, we only read the first 1 MiB
data from the request body. This limitation is configured via: data from the request body. This limitation is configured via:
```yaml ```yaml
@ -273,4 +273,4 @@ graphql:
``` ```
If you need to pass a graphql body which is larger than the limitation, you can increase the value in `conf/config.yaml`. If you need to pass a GraphQL body which is larger than the limitation, you can increase the value in `conf/config.yaml`.

1
docs/zh/latest/README.md
View File

@ -102,6 +102,7 @@ A/B 测试、金丝雀发布(灰度发布)、蓝绿部署、限流限速、抵
- 支持路由的[自动过期(TTL)](admin-api.md#route) - 支持路由的[自动过期(TTL)](admin-api.md#route)
- [支持路由的优先级](../../en/latest/router-radixtree.md#3-match-priority) - [支持路由的优先级](../../en/latest/router-radixtree.md#3-match-priority)
- [支持批量 Http 请求](plugins/batch-requests.md) - [支持批量 Http 请求](plugins/batch-requests.md)
- [支持通过GraphQL属性过滤路由](../../en/latest/router-radixtree.md#how-to-filter-route-by-graphql-attributes)
- **安全防护** - **安全防护**