Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/graphql/swapi-graphql

A GraphQL schema and server wrapping SWAPI.
https://github.com/graphql/swapi-graphql

graphql swapi swapi-graphql

Last synced: 26 days ago
JSON representation

A GraphQL schema and server wrapping SWAPI.

Lists

README 

        
SWAPI GraphQL Wrapper

=====================



A wrapper around [SWAPI](http://swapi.dev) built using GraphQL converting it into [this schema](schema.graphql).



Uses:



* [graphql-js](https://github.com/graphql/graphql-js) - a JavaScript GraphQL runtime.

* [DataLoader](https://github.com/graphql/dataloader) - for coalescing and caching fetches.

* [express-graphql](https://github.com/graphql/express-graphql) - to provide HTTP access to GraphQL.

* [aws-serverless-express](https://github.com/awslabs/aws-serverless-express) - to use `express-graphql` on aws lambda.

* [GraphiQL](https://github.com/graphql/graphiql) - for easy exploration of this GraphQL server.



Try it out at: http://graphql.org/swapi-graphql



[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/graphql/swapi-graphql)



## Getting Started



Install dependencies with



```sh

npm install

```



## SWAPI Wrapper



The SWAPI wrapper is in `./swapi`. It can be tested with:



```sh

yarn test

```



## Local Server



A local express server is in `./server`. It can be run with:



```sh

npm start

```



A GraphiQL instance will be opened at http://localhost:8080/ (or similar; the actual port number will be printed to the console) to explore the API.



# Contributing to this repo



This repository is managed by EasyCLA. Project participants must sign the free ([GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org) before making a contribution. You only need to do this one time, and it can be signed by [individual contributors](http://individual-spec-membership.graphql.org/) or their [employers](http://corporate-spec-membership.graphql.org/).



To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.



You can find [detailed information here](https://github.com/graphql/graphql-wg/tree/main/membership). If you have issues, please email [[email protected]](mailto:[email protected]).



If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the [GraphQL Foundation](https://foundation.graphql.org/join).