https://github.com/lrlna/graphql-schema-rs
[WIP] Schema Introspection given a GraphQL API Endpoint
https://github.com/lrlna/graphql-schema-rs
Last synced: 3 months ago
JSON representation
[WIP] Schema Introspection given a GraphQL API Endpoint
- Host: GitHub
- URL: https://github.com/lrlna/graphql-schema-rs
- Owner: lrlna
- Created: 2020-08-12T10:34:30.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-12T10:36:32.000Z (about 5 years ago)
- Last Synced: 2025-03-01T02:19:24.611Z (7 months ago)
- Language: Rust
- Size: 14.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GraphQL Schema
Explore a GraphQL Schema given an endpoint URL.
## Usage
```shell
graphql-explorer 0.1.0
Explore GraphQL schema given a URL
USAGE:
graphql-schema-rs
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
ARGS:
URL to a GraphQL API Endpoint
```
```shell
> graphql-schema https://bahnql.herokuapp.com/graphql
+----------------------+--------+--------------------------------------------------------------+
| NAME | KIND | DESCRIPTION |
+----------------------+--------+--------------------------------------------------------------+
| Query | OBJECT | |
+----------------------+--------+--------------------------------------------------------------+
| Int | SCALAR | The `Int` scalar type represents non-fractional signed whole |
| | | numeric values. Int can represent values between -(2^31) and |
| | | 2^31 - 1. |
+----------------------+--------+--------------------------------------------------------------+
| Route | OBJECT | |
+----------------------+--------+--------------------------------------------------------------+
| RoutePart | OBJECT | |
+----------------------+--------+--------------------------------------------------------------+
| Station | OBJECT | |
+----------------------+--------+--------------------------------------------------------------+
| String | SCALAR | The `String` scalar type represents textual data, |
| | | represented as UTF-8 character sequences. The String type is |
| | | most often used by GraphQL to represent free-form human- |
| | | readable text. |
+----------------------+--------+--------------------------------------------------------------+
| Location | OBJECT | |
+----------------------+--------+--------------------------------------------------------------+
| Float | SCALAR | The `Float` scalar type represents signed double-precision |
| | | fractional values as specified by [IEEE |
| | | 754](http://en.wikipedia.org/wiki/IEEE_floating_point). |
+----------------------+--------+--------------------------------------------------------------+
| Boolean | SCALAR | The `Boolean` scalar type represents `true` or `false`. |
+----------------------+--------+--------------------------------------------------------------+
```
## Future Considerations
Several features to consider:
- Allow for query (`--query`) and schema (`--schema`) path inputs
- Parse nested fields in FullType (in `query.graphql`)
- Allow for `authorization` (`--authorization`) for when using an enpoint that requires authorization
- Allow for writing to file output (`--output`)
- Allow user to toggle pretty vs json (`--pretty`)