-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
0 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,116 +1,3 @@ | ||
| # Introspect | ||
|
|
||
| ### ⚡ Serve you entire schema as `JSON` or [`SDL`](https://sdk.vercel.ai/s/2x7agG8) or as a [live playground](https://introspect.up.railway.app/graphiql/https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3) of any `GraphQL` API | ||
|
|
||
| ### Try it | ||
|
|
||
| Get the full `GraphQL` schema of Uniswap's API, formatted as `SDL`: | ||
|
|
||
| [`https://introspect.lagon.dev/sdl/https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3`](https://introspect.lagon.dev/sdl/https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3) | ||
|
|
||
| As `JSON`: | ||
|
|
||
| [`https://introspect.lagon.dev/json/https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3`](https://introspect.lagon.dev/json/https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3) | ||
|
|
||
| As a live playground: | ||
|
|
||
| [`https://introspect.lagon.dev/playground/https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3`](https://introspect.lagon.dev/playground/https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3) | ||
|
|
||
| #### 🔗 <https://introspect.lagon.dev> | ||
|
|
||
| ## When might I use this? | ||
|
|
||
| - To generate `TypeScript` types from a `GraphQL` API using [`graphql-codegen`](https://the-guild.dev/graphql/codegen) | ||
| - To use a third party `GraphQL` API that doesn't have a playground or `schema.json` available | ||
| - To see the full schema of a `GraphQL` API | ||
| - To play around with a `GraphQL` API in a [nice playground](https://introspect.lagon.dev/json/https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3) | ||
|
|
||
| ⚠️ _**Note** that if the provider disables introspection, this won't work. Usually introspection is enabled for public APIs. See example at the end of this doc._ | ||
|
|
||
| ## Usage | ||
|
|
||
| ```sh | ||
| curl --request GET 'https://introspect.lagon.dev/<format>/<introspection-url>' | ||
| ``` | ||
|
|
||
| - `<format>` can be `json` or `sdl` | ||
| - `<introspection-url>` is the URL of the `GraphQL` API you want to fetch the schema of | ||
|
|
||
| ### Try in Browser - SpaceX API | ||
|
|
||
| [`https://introspect.lagon.dev/json/https://spacex-production.up.railway.app`](https://introspect.lagon.dev/json/https://spacex-production.up.railway.app) | ||
|
|
||
| or get the `SDL` | ||
|
|
||
| [`https://introspect.lagon.dev/sdl/https://spacex-production.up.railway.app`](https://introspect.lagon.dev/sdl/https://spacex-production.up.railway.app) | ||
|
|
||
| or play around with it in a live playground | ||
|
|
||
| [`https://introspect.lagon.dev/playground/https://spacex-production.up.railway.app`](https://introspect.lagon.dev/playground/https://spacex-production.up.railway.app) | ||
|
|
||
| By default API will return schema as `JSON` | ||
|
|
||
| ### Passing `Headers` | ||
|
|
||
| If you're using a GraphQL endpoint that requires an API key, you can pass it in the `headers` like so: | ||
| ```json | ||
| { | ||
| "X-API-KEY-NAME": "<api-key-name>", | ||
| "X-API-KEY-VALUE": "<api-key-value>" | ||
| } | ||
| ``` | ||
|
|
||
| Example | ||
| ```json | ||
| { | ||
| "X-API-KEY": "Authorization", | ||
| "X-API-VALUE": "Bearer 1234567890" | ||
| } | ||
| ``` | ||
|
|
||
| To use the `playground`/`graphiql` endpoint when you need to pass headers (i.e., api key), you can `curl` the endpoint and save the response locally to an `html` file then simply open the file in your browser. | ||
|
|
||
| Example | ||
| ```sh | ||
| curl --request 'GET' \ | ||
| --url 'https://introspect.lagon.dev/graphiql/https://spacex-production.up.railway.app' \ | ||
| --header 'X-API-KEY-NAME: Authorization' \ | ||
| --header 'X-API-KEY-VALUE: Bearer loremipsum420' \ | ||
| --output 'playground.html' | ||
| ``` | ||
|
|
||
| ### Examples | ||
|
|
||
| Fetch Uniswap `GraphQL` API schema as `JSON`: | ||
|
|
||
| ```sh | ||
| curl --request GET 'https://introspect.lagon.dev/json/https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3' | ||
| ``` | ||
|
|
||
| Fetch Uniswap `GraphQL` API schema as `SDL` and save to `schema.graphql` file: | ||
|
|
||
| ```sh | ||
| curl --output schema.graphql 'https://introspect.lagon.dev/sdl/https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3' | ||
| ``` | ||
|
|
||
| ### Popular public `GraphQL` APIs | ||
|
|
||
| - **Uniswap v3**: <https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3> | ||
| - **GitLab**: <https://gitlab.com/api/graphql> (*quite large, so small chance function timesout*) | ||
| - **SpaceX** (unoffical): <https://spacex-production.up.railway.app> | ||
| - **GraphQL Pokemon**: <https://graphqlpokemon.favware.tech/v7> | ||
| - A bunch more here <https://github.com/graphql-kit/graphql-apis> | ||
|
|
||
| _____ | ||
|
|
||
| ❕if you want to run this yourself and you don't have access to **[Lagon Alpha](https://lagon.app/)**, install **<https://bun.sh>** and add the following a the bottom of **`./src/index.ts`**: | ||
|
|
||
| ```ts | ||
| const port = 3000 | ||
| Bun.serve({ | ||
| port, | ||
| fetch: request => handler(request) | ||
| }) | ||
|
|
||
| console.log(`Server ready at http://localhost:${port}`) | ||
| ``` |