README.md · ysun/starlette-graphql - Gitee.com

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

文件

克隆/下载

README.md 1.50 KB

# Starlette GraphQL

The starlette GraphQL implement, which  support query, mutate and subscription. Based on [python-gql](https://github.com/syfun/python-gql).

## Requirement

Python 3.7+

## Installation

`pip install starlette-graphql`

## Getting started

```python
# app.py
from gql import query, gql
from stargql import GraphQL

type_defs = gql("""
type Query {
    hello(name: String!): String!
}
""")

@query
async def hello(parent, info, name: str) -> str:
    return name

app = GraphQL(type_defs=type_defs)
```

Use [uvicorn](https://www.uvicorn.org) to run app.

`uvicorn app:app --reload`

## Upload File

```python
import uvicorn
from gql import gql, mutate
from stargql import GraphQL

type_defs = gql("""
 scalar Upload
 
 type File {
    filename: String!
  }

type Query {
    uploads: [File]
  }

type Mutation {
    singleUpload(file: Upload!): File!
    multiUpload(files: [Upload!]!): [File!]!
  }
""")

@mutate
def single_upload(parent, info, file):
    return file

@mutate
def multi_upload(parent, info, files):
    return files

app = GraphQL(type_defs=type_defs)

if __name__ == '__main__':
    uvicorn.run(app, port=8080)

```

## Subscription

For more about subscription, please see [gql-subscriptions](https://github.com/syfun/starlette-graphql).

## Apollo Federation

[Example](https://github.com/syfun/starlette-graphql/tree/master/examples/federation)

For more abount subscription, please see [Apollo Federation](https://www.apollographql.com/docs/apollo-server/federation/introduction/)

一键复制编辑原始数据按行查看历史

提交于 2020-08-26 09:25 . Feat/support federation (#2)

# Starlette GraphQL

The starlette GraphQL implement, which  support query, mutate and subscription. Based on [python-gql](https://github.com/syfun/python-gql).

## Requirement

Python 3.7+

## Installation

`pip install starlette-graphql`


## Getting started

```python
# app.py
from gql import query, gql
from stargql import GraphQL

type_defs = gql("""
type Query {
    hello(name: String!): String!
}
""")


@query
async def hello(parent, info, name: str) -> str:
    return name


app = GraphQL(type_defs=type_defs)
```

Use [uvicorn](https://www.uvicorn.org) to run app.

`uvicorn app:app --reload`

## Upload File

```python
import uvicorn
from gql import gql, mutate
from stargql import GraphQL

type_defs = gql("""
 scalar Upload
 
 type File {
    filename: String!
  }

  type Query {
    uploads: [File]
  }

  type Mutation {
    singleUpload(file: Upload!): File!
    multiUpload(files: [Upload!]!): [File!]!
  }
""")


@mutate
def single_upload(parent, info, file):
    return file


@mutate
def multi_upload(parent, info, files):
    return files


app = GraphQL(type_defs=type_defs)


if __name__ == '__main__':
    uvicorn.run(app, port=8080)

```

## Subscription

For more about subscription, please see [gql-subscriptions](https://github.com/syfun/starlette-graphql).

## Apollo Federation

[Example](https://github.com/syfun/starlette-graphql/tree/master/examples/federation)

For more abount subscription, please see [Apollo Federation](https://www.apollographql.com/docs/apollo-server/federation/introduction/)

Loading...

马建仓 AI 助手

尝试更多

代码解读

代码找茬

代码优化

1

https://gitee.com/acidrain/starlette-graphql.git

git@gitee.com:acidrain/starlette-graphql.git

acidrain

starlette-graphql

starlette-graphql

master