Categorygithub.com/vaniila/hyper
modulepackage
0.0.0-20190603091140-d91554c37e14
Repository: https://github.com/vaniila/hyper.git
Documentation: pkg.go.dev

# README

hyper

Build Status GoDoc

Package hyper implements an ease-of-use HTTP web framework for the Go programming language. Featuring GraphQL (w/ Subscription), DataLoader and Swagger integration.

Project Website: https://github.com/vaniila/hyper
API documentation: https://godoc.org/github.com/vaniila/hyper
API examples: https://github.com/vaniila/hyper/tree/master/examples

Installation

go get github.com/vaniila/hyper

Features

  • Built-in support for HTTP/2 protocol
  • Built-in support for Opentracing
  • Build GraphQL APIs
    • Support for GraphQL subscription via websocket
    • Implement custom object, argument, enum, scalar and union types
    • API to access the Dataloader interface
  • Support for websocket
    • Authorization via middleware functions
    • Scales horizontally with PubSub channels
  • Build RESTful with swagger integration
  • Built-in request validation (Query, Body and Header)
  • Support for namespaces
  • Customizable middleware and HTTP error handling
  • Define and use custom logger
  • Identity and access management
  • Configurable CORS
  • Automatic crash prevention

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

License

Copyright (c) Vaniila, Inc. and its affiliates. Use of this source code is governed by a MIT license that can be found in the LICENSE file.

# Packages

No description provided by the author
Package dataloader source: https://github.com/nicksrandall/dataloader dataloader is an implimentation of facebook's dataloader in go.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package gws is a generated protocol buffer package.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package sync is a generated protocol buffer package.
No description provided by the author

# Functions

Addr to change server bind address.
AfterStop to add after stop action to hyper server.
AllowCredentials to set allowed credentials.
AllowedHeaders to add allowed headers for CORS.
AllowedMethods to add allowed methods for CORS.
AllowedOrigins to add allowed origins for CORS.
AllowOriginFunc to add func to set CORS.
BeforeStart to add before start action to hyper server.
Body func.
Cache to set custom cache engine.
Context reads router context from context.Context.
Cookie func.
DataLoader to set custom dataloader.
EnableCompression to enable gzip compression.
ExposedHeaders to add exposed headers.
GraphQL handles graphql.
Header func.
HTTP to use 1.1 network protocol.
HTTP2 to use 2.0 network protocol.
ID to change server reference id.
Logger to set custom logger.
MaxAge to set max age header.
Message to set custom message broker.
Model func.
New creates a hyper server.
OneOf group func.
OptionsPassthrough to set options pass through value.
Param func.
Parse reads router context from context.Context.
Query func.
Router to set custom router.
Sync to set custom sync engine.
TraceID to set trace id generator function.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
HTTP Status.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

GQLBodies parameters.
GQLQueries parameters.

# Structs

Hyper service.
Options is the hyper server options.
Payload struct.

# Type aliases

Option func.