Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Schemas should be exposed via API endpoints #66

Open
magnusbaeck opened this issue May 18, 2022 · 1 comment
Open

Schemas should be exposed via API endpoints #66

magnusbaeck opened this issue May 18, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@magnusbaeck
Copy link
Member

Description

We should expose the GraphQL schema via API endpoints, perhaps /graphql/schema/json and /graphql/schema/sdl. (I have a feeling that there already is such an endpoint since GraphiQL is working but I wasn't able to locate which URL endpoint it uses.)

Motivation

This would allow e.g. end user clients and documentation tools to show relevant information without knowing anything about the service.

Exemplification

Backstage is capable of fetching an API's SDL definition via HTTP and exposing it to the user.

Benefits

Better interaction with third-party tools and clients for end users.

Possible Drawbacks

None.

@magnusbaeck magnusbaeck added the enhancement New feature or request label May 18, 2022
@magnusbaeck
Copy link
Member Author

See graphql-python/graphene#3 for examples of how to get hold of the different schema representations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant