GraphQL API
在Steedos中配置对象时,会自动为您生成GraphQL API。
使用GraphQL API,您可以要求所需的确切信息。详情参考GraphQL API。
您可以通过URL访问GraphQL接口,也可以通过客户端的方式,具体方式如下:
#
URL访问GraphQL默认以“ip:localhost”,“端口:5000”启动服务
#
URL#
请求参数以 JSON 格式传入请求参数。
Param | Required | Type | Description |
---|---|---|---|
query | true | string | 要传入的 GraphQL 脚本 |
示例如下:
返回结果如下:
#
客户端访问GraphQL假设您已经使用端口5000启动了华炎魔方的本地服务,那么您可以使用http://localhost:5000/graphql
来访问GraphQL客户端。
在GraphQL客户端中,您可以在左侧面板中输入GraphQL脚本,然后通过单击页面顶部的运行按钮来运行它。
以下是一些可以直接在客户端上运行的示例。
#
示例询问所有帐户:
提示
您也可以省略请求头的‘query’,返回结果相同。
结果如下:
#
扩展查询您可以在对象名称和括号之后定义字段结构,扩展字段并查询相关字段值。
字段结构定义如下:
返回结果如下:
#
查询数据您可以通过 GraphQL API 使用 filters
,fields
,top
,skip
和sort
查询数据的记录,详见通过GraphQL API查询数据
示例:
查询所有status
属性值为Qualified
的线索:
结果如下:
提示
您也可以使用 filters:"status eq 'Qualified'" 替换 filters:[["status", "=" "Qualified"]],它是一个标准的OData过滤字符串。