pkg

package
v1.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 14, 2023 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	StatusUp                 = "UP"
	StatusDown               = "DOWN"
	StatusDegraded           = "DEGRADED"
	DefaultAppName           = "gofr-app"
	DefaultAppVersion        = "dev"
	Framework                = "gofr-" + log.GofrVersion
	PathHealthCheck          = "/.well-known/health-check"
	PathHeartBeat            = "/.well-known/heartbeat"
	PathOpenAPI              = "/.well-known/openapi.json"
	PathSwagger              = "/.well-known/swagger"
	PathSwaggerWithPathParam = "/.well-known/swagger/{name}"
	FrameworkMetricsPrefix   = "zs_"
)

Variables

This section is empty.

Functions

This section is empty.

Types

This section is empty.

Source Files

View all Source files

Directories

Path Synopsis
pubsub
Package pubsub implements the necessary methods and types to work with publish-subscribe messaging patterns.
 Package pubsub implements the necessary methods and types to work with publish-subscribe messaging patterns.
pubsub/avro
Package avro provides implementation methods for working with avro to serialize and deserialize messages.
 Package avro provides implementation methods for working with avro to serialize and deserialize messages.
pubsub/eventbridge
Package eventbridge provides methods to interact with AWS Eventbridge service allowing user to publish events to Eventbridge
 Package eventbridge provides methods to interact with AWS Eventbridge service allowing user to publish events to Eventbridge
pubsub/eventhub
Package eventhub provides methods to interact, publish and consume events from Azure Eventhub
 Package eventhub provides methods to interact, publish and consume events from Azure Eventhub
pubsub/google
Package google provides methods to work with Google Cloud Pub/Sub enabling the publishing and consumption of messages.
 Package google provides methods to work with Google Cloud Pub/Sub enabling the publishing and consumption of messages.
pubsub/kafka
Package kafka provides methods to interact with Apache Kafka offering functionality for both producing and consuming messages from kafka-topics.
 Package kafka provides methods to interact with Apache Kafka offering functionality for both producing and consuming messages from kafka-topics.
Package errors have the predefined errors that can be used to denote various types of errors
 Package errors have the predefined errors that can be used to denote various types of errors
Package file provides various functionalities for reading, writing and manipulating files and supports different file storage backends like aws, azure, gcp, sftp, ftp along with the support for local files.
 Package file provides various functionalities for reading, writing and manipulating files and supports different file storage backends like aws, azure, gcp, sftp, ftp along with the support for local files.
Package gofr provides a comprehensive framework for building web applications following RESTful principles.
 Package gofr provides a comprehensive framework for building web applications following RESTful principles.
assert
Package assert provides the functionality to check the correctness of the output of a command line function
 Package assert provides the functionality to check the correctness of the output of a command line function
cache
Package cache implements a basic redis cache which provides functionality to interact with redis
 Package cache implements a basic redis cache which provides functionality to interact with redis
config
Package config provides the functionality to read environment variables it has the power to read from a static config file or from a remote config server
 Package config provides the functionality to read environment variables it has the power to read from a static config file or from a remote config server
metrics
Package metrics provides the functionality to create custom metrics for applications
 Package metrics provides the functionality to create custom metrics for applications
request
Package request provides the implementation of operations related to a http and cmd request it gives the features like reading parameters, bind request body, etc.
 Package request provides the implementation of operations related to a http and cmd request it gives the features like reading parameters, bind request body, etc.
responder
Package responder provides the functionality to populate the responses for the respective incoming requests
 Package responder provides the functionality to populate the responses for the respective incoming requests
template
Package template provides the functionality to render html pages based on the html/templates provided by go
 Package template provides the functionality to render html pages based on the html/templates provided by go
types
Package types provides most common structures that can be used in a http server This package also implements a validation function for all the types that check the validity of the values in the fields of these structures
 Package types provides most common structures that can be used in a http server This package also implements a validation function for all the types that check the validity of the values in the fields of these structures
datasource/cassandra Module
datasource/clickhouse Module
datasource/dgraph Module
datasource/file/ftp Module
datasource/file/s3 Module
datasource/file/sftp Module
datasource/kv-store/badger Module
datasource/mongo Module
datasource/pubsub/eventhub Module
datasource/pubsub/nats Module
datasource/solr Module
Package log provides logger for logging various output messages in different formats, including color-coded terminal output and JSON.Gofr logger supports different log levels such as INFO, ERROR, WARN, DEBUG, or FATAL.
 Package log provides logger for logging various output messages in different formats, including color-coded terminal output and JSON.Gofr logger supports different log levels such as INFO, ERROR, WARN, DEBUG, or FATAL.
Package middleware provides set of middleware functions that can be used to authenticate and authorize requests in HTTP server.It also supports handling CORS, propagating headers, integrating with New Relic APM, and enabling distributed tracing using OpenTelemetry.
 Package middleware provides set of middleware functions that can be used to authenticate and authorize requests in HTTP server.It also supports handling CORS, propagating headers, integrating with New Relic APM, and enabling distributed tracing using OpenTelemetry.
oauth
Package oauth provides a middleware for authenticating requests.This package provides functionality for token validation and integration with JSON Web Key (JWK) to verify JSON Web Tokens (JWT).
 Package oauth provides a middleware for authenticating requests.This package provides functionality for token validation and integration with JSON Web Key (JWK) to verify JSON Web Tokens (JWT).
Package notifier defines Notifier interface and Message struct responsible for facilitating communication and coordination between different components of an application.
 Package notifier defines Notifier interface and Message struct responsible for facilitating communication and coordination between different components of an application.
aws-sns
Package awssns provides notifier implementation for AWS Simple Notification Service(SNS) to publish-subscribe messages to an SNS topic.It offers features like message attribute customization and health checks to ensure the notifier's availability.
 Package awssns provides notifier implementation for AWS Simple Notification Service(SNS) to publish-subscribe messages to an SNS topic.It offers features like message attribute customization and health checks to ensure the notifier's availability.
Package service provides generic HTTP client that can be used to call remote services.The service package also provides support for custom headers, authentication, caching settings, and surge protection options.The package defines three main interfaces: HTTP, SOAP, and Cacher, which can be used to implement various service clients.
 Package service provides generic HTTP client that can be used to call remote services.The service package also provides support for custom headers, authentication, caching settings, and surge protection options.The package defines three main interfaces: HTTP, SOAP, and Cacher, which can be used to implement various service clients.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.