doc

package module
v1.1.1-dev.4 Latest Latest
Warning

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

Go to latest
Published: Jun 11, 2020 License: Apache-2.0 Imports: 0 Imported by: 0

README

Go

Application Functions SDK

Welcome the App Functions SDK for EdgeX. This sdk is meant to provide all the plumbing necessary for developers to get started in processing/transforming/exporting data out of EdgeX.

For documentation please visit https://docs.edgexfoundry.org/1.2/microservices/application/ApplServices/. For a list of examples please visit https://docs.edgexfoundry.org/1.2/examples/AppServiceExamples/

Build Prerequisites

Please see the edgex-go README.

Documentation

Overview

App Functions SDK API.

Welcome the App Functions SDK for EdgeX. This sdk is meant to provide all the plumbing necessary for developers to get started in processing/transforming/exporting data out of EdgeX. For full documentation on this SDK please visit https://github.com/edgexfoundry/app-functions-sdk-go/blob/master/README.md

This Swagger Document focuses on the few restful APIs provided with the SDK, however the complete documentation for all available features can be found here https://github.com/edgexfoundry/app-functions-sdk-go/blob/master/README.md .

Schemes: http
Host: localhost
BasePath: /api/v1/
Version: 1.0.0
License: Apache-2.0 https://github.com/edgexfoundry/app-functions-sdk-go/blob/master/LICENSE

Contact: https://edgex.discourse.group/c/applications

Consumes:
- application/json

Produces:
- application/json

swagger:meta

Directories

Path Synopsis
store/contracts
contracts are implementation agnostic data storage models.
contracts are implementation agnostic data storage models.
store/db
db provides useful constants, identifiers, and simple types that apply to all implementations of the store
db provides useful constants, identifiers, and simple types that apply to all implementations of the store
store/db/interfaces
interfaces establishes the contract required for any implementation of the export store functionality in a database provider.
interfaces establishes the contract required for any implementation of the export store functionality in a database provider.
store/db/mongo
mongo provides the Mongo implementation of the StoreClient interface.
mongo provides the Mongo implementation of the StoreClient interface.
store/db/mongo/models
models describes the data types that will be used when storing export data in Mongo.
models describes the data types that will be used when storing export data in Mongo.
store/db/redis
redis provides the Redis implementation of the StoreClient interface.
redis provides the Redis implementation of the StoreClient interface.
store/db/redis/models
models describes the data types that will be used when storing export data in Redis.
models describes the data types that will be used when storing export data in Redis.
pkg
urlclient
urlclient provides functions to integrate the client code in go-mod-core-contracts with application specific code
urlclient provides functions to integrate the client code in go-mod-core-contracts with application specific code

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL