README.md

SubKit GraphQL-Server Documentation

Principles

SubKit GraphQL-Server is built with the following principles in mind:

• Simplicity by keeping things simple, SubKit GraphQL-Server is easier to use, easier to contribute to, and more secure
• Performance SubKit GraphQL-Server is well-tested and production-ready - no modifications needed
• Experience Front-end / Contract-Driven approach - designed and developed to make front-end and back-end development as efficient as possible.
• Build-In All important tools to create and manage GraphQL-APIs are available via CLI.

Anyone is welcome to contribute to SubKit GraphQL-Server, just read CONTRIBUTING and take a look at the ROADMAP.

• Guide to Getting Started
  • Installation
  • CLI
  • Setup a GraphQL-Server
  • Programmers Guide
• Queries
  • Create GraphQL-Schema via SDL
  • GraphQL Types
  • Implement query resolver functions
  • Usage of resolver function context
  • Usage of GraphQL query variables
• Advanced queries
  • Relational data queries
    • Expand the GraphQL-Schema
    • Implement the resolver functions
    • Execute a GraphQL query
    • Prepare and usage of persistent GraphQL query
• Clients
  • cURL
  • HTTP-Fetch
  • SubKit request
• Mutations
  • Expand the GraphQL-Schema
  • Implement the resolver functions
  • Execute a GraphQL mutation query
  • Usage of GraphQL mutation variables
• Subscriptions
  • Setup and Subscribe to GraphQL-Subscriptions
  • Use Publish/Subscribe programmatically
  • Publish via Web-Hooks
• Directives
  • Build-In
    • @mock
    • @fetchJSON / @getJSON
    • @postJSON
    • @putJSON
    • @deleteJSON
    • @publish
    • @contextify
  • Programming Custom-Directives
• JSON Web Token (JWT) Authentication
  • Encode a JSON Web Token
  • Verify and decode a JSON Web Token
  • Request GraphQL-API using JSON Web Token
  • Usage of JWT authentication for authorization
• More examples
• Error Handling (coming soon)
  • Domain errors
  • Infrastructure errors
• Instrumentation - Tracing and Logging (coming soon)
• Testing (coming soon)
• Batching and Caching (coming soon)
• Include SubKit GraphQL-Server as a Module (coming soon)