https://github.com/moesif/moesif-express-graphql-example
An example of using Moesif with Express GraphQL server. https://www.moesif.com
https://github.com/moesif/moesif-express-graphql-example
Last synced: 8 months ago
JSON representation
An example of using Moesif with Express GraphQL server. https://www.moesif.com
- Host: GitHub
- URL: https://github.com/moesif/moesif-express-graphql-example
- Owner: Moesif
- Created: 2019-10-18T01:17:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T09:50:54.000Z (almost 3 years ago)
- Last Synced: 2025-01-05T21:12:05.716Z (9 months ago)
- Language: JavaScript
- Size: 47.9 KB
- Stars: 0
- Watchers: 8
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Moesif Express-GraphQL Example
[Moesif](https://www.moesif.com/features/graphql-analytics) is an API Analytics and monitoring platform for [GraphQL](https://www.moesif.com/features/graphql-analytics).
This example builds upon the [get started example](https://graphql.org/graphql-js/running-an-express-graphql-server/) from the official guide on GraphQL's website to demonstrate how you can set up Moesif quickly using the [moesif express](https://www.moesif.com/docs/server-integration/express/) middleware.
## Summary of key changes
Express-GraphQL server works with any express app. When you set up Express-GraphQL server with express, you can simply add the moesif-express
middleware. Below summarizes the code needed. See `index.js` from this package for details.
```javascript
const express = require('express');
const graphqlHTTP = require('express-graphql');
const { buildSchema } = require('graphql');
const moesifExpress = require('moesif-express');
const bodyParser = require('body-parser-graphql');
// ...
const app = express();
const moesifOptions = {
applicationId: 'Your Moesif Application Id'
};
const moesifMiddleware = moesifExpress(moesifOptions);
// this adds moesif middleware to express app.
app.use(moesifMiddleware);
// body-parser that supports the application/graphql type
app.use(bodyParser.bodyParserGraphQL())
// this adds graphql server to the express app.
app.use('/graphql', graphqlHTTP({
schema: schema,
rootValue: root,
graphiql: true,
}));
const port = 6868;
app.listen({ port }, () => {
console.log(`Running a GraphQL API server at http://localhost:${port}/graphql`);
})
```
Your Moesif Application Id can be found in the [_Moesif Portal_](https://www.moesif.com/).
After signing up for a Moesif account, your Moesif Application Id will be displayed during the onboarding steps.
You can always find your Moesif Application Id at any time by logging
into the [_Moesif Portal_](https://www.moesif.com/), click on the top right menu,
and then clicking _Installation_.
## To run this example:
- open up `index.js` and replace application id with the application id obtained from Moesif.
- run `npm install` to install all dependencies.
- start the app `node index.js`
- use browser to navigate to `http://localhost:6868/graphql`
- run some test queries, for example:
```
query {
books { title }
}
```
You should see the GraphQL request captured in your Event Stream, it is where it will show up first.
## Notes
- You'll notice other requests besides GraphQL are captured also. That is ok and expected, since moesif-express
works at a lower level than GraphQL. You can change this default by modify the skip option of moesif-express.
- If you are using Express-GraphQL to create a wrapper around other restful APIs, you may consider capture all outgoing API calls so you get the big pictures of how everything is connected:
```javascript
moesifMiddleware.startCaptureOutgoing();
```
- Go to [moesif-express](https://github.com/Moesif/moesif-express) SDK documentation for more configuration options.
- For more information on what you can do with [API analytics for GraphQL check out here](https://www.moesif.com/docs/platform/graphql/).