Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/acro5piano/graphql-rest-proxy
Turn your REST API into GraphQL - A Proxy Server that pipes request from GraphQL to REST with GraphQL DSL, performant nested children, mutations, input types, and more.
https://github.com/acro5piano/graphql-rest-proxy
cli-app expressjs graphql graphql-server javascript proxy rest-api typescript
Last synced: 30 days ago
JSON representation
Turn your REST API into GraphQL - A Proxy Server that pipes request from GraphQL to REST with GraphQL DSL, performant nested children, mutations, input types, and more.
- Host: GitHub
- URL: https://github.com/acro5piano/graphql-rest-proxy
- Owner: acro5piano
- License: mit
- Created: 2019-03-21T06:55:24.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-01T19:59:02.000Z (over 1 year ago)
- Last Synced: 2024-10-03T09:35:59.866Z (about 1 month ago)
- Topics: cli-app, expressjs, graphql, graphql-server, javascript, proxy, rest-api, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/graphql-rest-proxy
- Size: 1.49 MB
- Stars: 253
- Watchers: 4
- Forks: 10
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/graphql-rest-proxy)
[](https://codecov.io/gh/acro5piano/graphql-rest-proxy)
# graphql-rest-proxy
Convert your REST server to GraphQL server.
# Install
```sh
npm -g install graphql-rest-proxy
```
Or if you use Yarn:
```sh
yarn global add graphql-rest-proxy
```
# Why
We all know GraphQL is great, so you want to move from REST API to GraphQL.
However, it requires a lot of effort to replace your current REST API with a brand new GraphQL server.
`graphql-rest-proxy` comes in to address this issue. It proxies GraphQL to REST API according to the defined schema.
# Getting Started
**STEP 1. Define your schema.**
`schema.graphql`
```graphql
type User {
id: Int
name: String
isActive: Boolean
}
type Query {
getUser: User @proxy(get: "https://my-rest-api.com/user")
}
```
**STEP 2. Run your proxy server.**
```sh
graphql-rest-proxy schema.graphql
# => graphql-rest-proxy is running on http://localhost:5252
```
**STEP 3. Request!**
```graphql
curl -XPOST -H 'Content-Type: application/json' \
-d '{ "query": "{ getUser { id name isActive } }" }' \
http://localhost:5252/graphql
```
It will return like this:
```json
{
"data": {
"getUser": {
"id": 1,
"name": "Tom",
"isActive": false
}
}
}
```
# Examples
**Basic Query Proxy**
```graphql
type User {
id: Int
name: String
}
type Query {
getUser: User @proxy(get: "https://my-rest-api.com/user")
getUsers: [User] @proxy(get: "https://my-rest-api.com/users")
}
```
**Query with Parameters**
You can refer the id of query args by `$id`.
```graphql
type User {
id: Int
name: String
}
type Query {
getUserById(id: Int!): User @proxy(get: "https://my-rest-api.com/users/$id")
}
```
**Mutation with Input Parameters**
Mutation forward `variables` to the REST API.
```graphql
input UserInput {
name: String!
}
type User {
id: Int
name: String
}
type Mutation {
createUser(user: UserInput!): User @proxy(post: "https://my-rest-api.com/users")
updateUser(id: Int!, user: UserInput!): User @proxy(patch: "https://my-rest-api.com/users/$id")
}
```
Request example:
```javascript
fetch('http://localhost:5252/graphql', {
method: 'patch',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
query: gql`
mutation UpdateUser($id: Int!, $user: UserInput!) {
updateUser(id: $id, user: $user) {
id
name
}
}
`,
variables: {
id: 1,
user: {
name: 'acro5piano',
},
},
}),
})
```
**Nested Objects**
You can refer the id of parent object by `$id`.
```graphql
type Post {
id: Int
title: String
}
type User {
id: Int
name: String
posts: [Post] @proxy(get: "https://my-rest-api.com/users/$id/posts")
}
type Query {
getUser: User @proxy(get: "https://my-rest-api.com/user")
}
```
**Specify base url**
You can set base url to reduce verbosity:
```sh
graphql-rest-proxy --baseUrl https://my-rest-api.com schema.graphql
```
```graphql
type Query {
getUser: User @proxy(get: "/user")
}
```
# Configuration
CLI options are:
```
Usage: graphql-rest-proxy [options]
Commands:
graphql-rest-proxy Start graphql-rest-proxy server. [default]
graphql-rest-proxy print Print GraphQL schema
Options:
--version Show version number [boolean]
-c, --config Specify config file
-p, --port Specify port
-b, --baseUrl Specify proxy base url
-h, --help Show help [boolean]
```
You can also set a config file.
`proxy.config.js`
```javascript
module.exports = {
baseUrl: 'https://myapi.com',
port: 3000,
}
```
And run with the configuration:
```sh
graphql-rest-proxy --config proxy.config.js schema.graphql
```
# Notes
**Request as less as possible**
`graphql-rest-proxy` does not request if proxy response includes child object. This means you can reduce API call if you includes child object.
For example, if the schema is like this:
```graphql
type Post {
id: Int
title: String
}
type User {
id: Int
name: String
posts: [Post] @proxy(get: "https://my-rest-api.com/users/$id/posts")
}
type Query {
getUser: User @proxy(get: "https://my-rest-api.com/user")
}
```
And REST API returns like this:
```sh
curl https://my-rest-api.com/user
```
```json
{
"id": 1,
"name": "acro5piano",
"posts": {
"id": 1,
"title": "graphql-rest-proxy"
}
}
```
In this case, `posts` is embbed in response, so `graphql-rest-proxy` doesn't request to `https://my-rest-api.com/users/1/posts`.
# Development Status
Still in Beta. If you have any suggestions or feature requests, feel free to open new issues or Pull Requests!
TODO:
- [ ] More type support
- [ ] Fragment
- [ ] Scalar
- [ ] Refactoring
- [ ] Logging