# sample-service

**Repository Path**: EdgexFoundry/sample-service

## Basic Information

- **Project Name**: sample-service
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-28
- **Last Updated**: 2025-09-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sample-service
[![Build Status](https://jenkins.edgexfoundry.org/view/EdgeX%20Foundry%20Project/job/edgexfoundry/job/sample-service/job/main/badge/icon)](https://jenkins.edgexfoundry.org/view/EdgeX%20Foundry%20Project/job/edgexfoundry/job/sample-service/job/main/) [![Code Coverage](https://codecov.io/gh/edgexfoundry/sample-service/branch/main/graph/badge.svg?token=QrtB3XMRUl)](https://codecov.io/gh/edgexfoundry/sample-service) [![Go Report Card](https://goreportcard.com/badge/github.com/edgexfoundry/sample-service)](https://goreportcard.com/report/github.com/edgexfoundry/sample-service) [![GitHub Latest Dev Tag)](https://img.shields.io/github/v/tag/edgexfoundry/sample-service?include_prereleases&sort=semver&label=latest-dev)](https://github.com/edgexfoundry/sample-service/tags) ![GitHub Latest Stable Tag)](https://img.shields.io/github/v/tag/edgexfoundry/sample-service?sort=semver&label=latest-stable) [![GitHub License](https://img.shields.io/github/license/edgexfoundry/sample-service)](https://choosealicense.com/licenses/apache-2.0/) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/edgexfoundry/sample-service) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr-raw/edgexfoundry/sample-service)](https://github.com/edgexfoundry/sample-service/pulls) [![GitHub Contributors](https://img.shields.io/github/contributors/edgexfoundry/sample-service)](https://github.com/edgexfoundry/sample-service/contributors) [![GitHub Committers](https://img.shields.io/badge/team-committers-green)](https://github.com/orgs/edgexfoundry/teams/devops-core-team/members) [![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/edgexfoundry/sample-service)](https://github.com/edgexfoundry/sample-service/commits)


## Not for production use
Sample service is a basic hello-world application that is used by the EdgeX DevOps working group for build automation / validation of Jenkins Pipelines.

The base functionality is derived from the 'device-random' service. This is a working service that will generate a random int8 value when queried.

Get an edgeX docker-compose from [developer-scripts](https://github.com/edgexfoundry/developer-scripts/tree/master/releases)


To start the sample-service:
```
cd /sample-service
make clean
make docker
docker-compose up sample-service
```

Confirm the service `edgexfoundry/docker-sample-service-go` is running:
```
docker-compose ps
```

To access the API endpoints, in a webbrowser, CURL or POSTMAN,
```
http://localhost:48082/api/v1/device/name/sample-service01
```
The command endpoint for 'GenerateRandomValue_Int8' will be displayed and can be directly accessed. Take note that `edge-core-command` should be replaced by 'localhost' if you are running locally and the '<unique_ID>' fields are unique to your instance of EdgeX.
```
http://localhost:48082/api/v1/device/<unique_ID>/command/<unique_ID>
```

Useful References:

[edgex-examples](https://github.com/edgexfoundry/edgex-examples)

[device-random](https://github.com/edgexfoundry/device-random)