search

zowe / api-layer

The API Mediation Layer provides a single point of access for mainframe service REST APIs.
Eclipse Public License 2.0
54 stars 62 forks source link

Properly visualize the GraphQL Documentation as part of the API Catalog #3187

Open balhar-jakub opened 10 months ago

balhar-jakub commented 10 months ago

Is your feature request related to a problem? Please describe. There is a new type of the Restful APIs that's known as GraphQL. The key difference is that the API provides only one endpoint and all the functionality is provided via parameters. The documentation of such APIs aren't done via Open API specification but via internal GraphQL documentation.

Describe the solution you'd like I want API Catalog to be able to integrate with the GraphQL and show the documentation for the GrahQL natively. I also want to update conformance to reflect different requirements for GraphQL documentation.

Describe alternatives you've considered Providing the link to the GraphQL documentation as only endpoint within Open API specification. It works but doesn't provide good user experience.

Additional Context We may be able to leverage something like this to integrate the doc - https://github.com/graphql/graphiql

github-actions[bot] commented 4 months ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.