title: REST Link
⚠️ This library is under active development ⚠️
This library is under active development. For information on progress check out this issues or the design. We would love your help with writing docs, testing, anything! We would love for you, yes you, to be a part of the Apollo community!
Purpose
An Apollo Link to easily try out GraphQL without a full server. It can be used to prototype, with third-party services that don't have a GraphQL endpoint or in a transition from REST to GraphQL.
Installation
npm install apollo-link-rest --save # or `yarn add apollo-link-rest`
Usage
Basics
;// Other necessary imports... // Create a RestLink for the Github APIconst link = uri: "https://api.github.com" ; // Configure the ApolloClient with the default cache and RestLinkconst client = cache: link; // A simple query to retrieve metada about a this repositoryconst query = gql` query Repo { repo @rest(type: "Repo", path: "/repos/apollographql/apollo-link-rest") { id name description } }`; // Invoke the query and log the response dataclient;
Apollo Client & React Apollo
// Standard React Component, using the injected data prop.Component<Props {}> public { const data = thisprops; if data && datarepo return <div> <h3> <a href=datarepohtml_url>datareponame</a> </h3> <p>datarepodescription</p> </div> ; else return null; } // Setup a basic query to retrieve data for that repository given a nameconst query = gql` query Repo($name: String!) { repo(name: $name) @rest(type: "Repo", path: "/repos/apollographql/:name") { id name description html_url } }`; // Connect the component using React Apollo's higher order component// and inject the data into the component. The Result type is what// we expect the shape of the response to be and OwnProps is what we// expect to be passed to this component.const Repo = graphql<Result OwnProps>query variables: name RepoBase; // Then, to use the <Repo /> component, pass the `name` of the repository;
Options
REST Link takes an object with some options on it to customize the behavior of the link. The options you can pass are outlined below:
uri
: the URI key is a string endpoint (optional whenendpoints
provides a default)endpoints
: root endpoint (uri) to apply paths to or a map of endpointscustomFetch
: a customfetch
to handle REST callsheaders
: an object representing values to be sent as headers on the requestcredentials
: a string representing the credentials policy you want for the fetch callfieldNameNormalizer
: function that takes the response field name and converts it into a GraphQL compliant name
Context
REST Link uses the headers
field on the context to allow passing headers to the HTTP request. It also supports the credentials
field for defining credentials policy.
headers
: an object representing values to be sent as headers on the requestcredentials
: a string representing the credentials policy you want for the fetch call
Contributing
This project uses TypeScript to bring static types to JavaScript and uses Jest for testing. To get started, clone the repo and run the following commands:
npm install # or `yarn` npm test # or `yarn test` to run tests npm test -- --watch # run tests in watch mode npm run check-types # or `yarn check-types` to check TypeScript types
To run the library locally in another project, you can do the following:
npm link # in the project you want to run this in npm link apollo-link-rest