README
¶
modware-order
dictyBase API server to manage order of biological stocks. The API server supports gRPC protocol for data exchange.
Usage
NAME:
modware-order - cli for modware-order microservice
USAGE:
modware-order [global options] command [command options] [arguments...]
VERSION:
1.0.0
COMMANDS:
start-server starts the modware-order microservice with grpc backends
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--log-format value format of the logging out, either of json or text. (default: "json")
--log-level value log level for the application (default: "error")
--help, -h show help
--version, -v print the version
Subcommand
NAME:
modware-order start-server - starts the modware-order microservice with grpc backends
USAGE:
modware-order start-server [command options] [arguments...]
OPTIONS:
--arangodb-pass value, --pass value arangodb database password [$ARANGODB_PASS]
--arangodb-database value, --db value arangodb database name [$ARANGODB_DATABASE]
--arangodb-user value, --user value arangodb database user [$ARANGODB_USER]
--arangodb-host value, --host value arangodb database host (default: "arangodb") [$ARANGODB_SERVICE_HOST]
--arangodb-port value arangodb database port (default: "8529") [$ARANGODB_SERVICE_PORT]
--is-secure flag for secured or unsecured arangodb endpoint
--nats-host value nats messaging server host [$NATS_SERVICE_HOST]
--nats-port value nats messaging server port [$NATS_SERVICE_PORT]
--port value tcp port at which the server will be available (default: "9560")
--order-collection value arangodb collection for storing stock orders (default: "stock_order")
--reflection, --ref flag for enabling server reflection
Default Names
There is only one collection, and its default name is stock_order.
API
gRPC
The protocol buffer definitions and service apis are documented here.
Misc badges
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
modware-order
command
Package main provides the entry point for the modware-order microservice.
|
Package main provides the entry point for the modware-order microservice. |
|
internal
|
|
|
app/server
Package server provides the gRPC server implementation for the order service.
|
Package server provides the gRPC server implementation for the order service. |
|
app/service
Package service provides the gRPC service implementation for order management.
|
Package service provides the gRPC service implementation for order management. |
|
app/validate
Package validate provides validation functions for CLI arguments.
|
Package validate provides validation functions for CLI arguments. |
|
message
Package message provides interfaces for message publishing.
|
Package message provides interfaces for message publishing. |
|
message/nats
Package nats provides NATS-based message publisher implementation.
|
Package nats provides NATS-based message publisher implementation. |
|
model
Package model defines data structures for order management.
|
Package model defines data structures for order management. |
|
repository
Package repository defines the interface for order data access.
|
Package repository defines the interface for order data access. |
|
repository/arangodb
Package arangodb provides ArangoDB implementation of the order repository.
|
Package arangodb provides ArangoDB implementation of the order repository. |
Click to show internal directories.
Click to hide internal directories.