README
¶
Mainflux HTTP adapter
Mainflux HTTP adapter provides an HTTP API for sending messages through the platform.
Configuration
The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.
| Variable | Description | Default |
|---|---|---|
| HTTP_ADAPTER_NATS_URL | NATS instance URL | nats://localhost:4222 |
Deployment
The service is distributed as Docker container. The following snippet provides a compose file template that can be used to deploy the service container locally:
version: "2"
services:
adapter:
image: mainflux/http-adapter:[version]
container_name: [instance name]
ports:
- [host machine port]:8180
environment:
HTTP_ADAPTER_NATS_URL: [NATS instance URL]
To start the service outside of the container, execute the following shell script:
# download the latest version of the service
go get github.com/mainflux/mainflux
cd $GOPATH/src/github.com/mainflux/mainflux/cmd/http
# compile the app; make sure to set the proper GOOS value
CGO_ENABLED=0 GOOS=[platform identifier] go build -ldflags "-s" -a -installsuffix cgo -o app
# set the environment variables and run the service
HTTP_ADAPTER_NATS_URL=[NATS instance URL] app
Usage
For more information about service capabilities and its usage, please check out the API documentation.
Documentation
¶
Overview ¶
Package http contains the domain concept definitions needed to support Mainflux http adapter service functionality.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Service ¶
type Service interface {
// Publish accepts the raw SenML message and publishes it to the event bus
// for post processing.
Publish(writer.RawMessage) error
}
Service specifies an API that must be fullfiled by the domain service implementation, and all of its decorators (e.g. logging & metrics).
func NewService ¶
func NewService(mr writer.MessageRepository) Service
NewService instantiates the domain service implementation.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api contains API-related concerns: endpoint definitions, middlewares and all resource representations.
|
Package api contains API-related concerns: endpoint definitions, middlewares and all resource representations. |
|
Package nats contains NATS-specific message repository implementation.
|
Package nats contains NATS-specific message repository implementation. |