Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rytswd/color-svc
https://github.com/rytswd/color-svc
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rytswd/color-svc
- Owner: rytswd
- License: mit
- Created: 2020-12-16T13:42:48.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-07T01:29:54.000Z (over 1 year ago)
- Last Synced: 2024-06-19T16:46:15.373Z (7 months ago)
- Language: Go
- Size: 37.1 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# color-svc
Simple HTTP server that gives you random color output.
[](build-status) | [](mit) | [](releases) | [](docker-release)
[build-status]: https://github.com/rytswd/color-svc/actions
[mit]: https://opensource.org/licenses/MIT
[releases]: https://github.com/rytswd/color-svc/releases
[docker-release]: https://hub.docker.com/r/rytswd/color-svc
## 🌅 Contents
- [Why and What is this for?](#-why-and-what-is-this-for)
- [Getting Started](#-getting-started)
- [Available Endpoints](#-available-endpoints)
- [How to Use](#-how-to-use)
- [Server Configurations](#-server-configurations)
## ❓ Why and What is this for?
This is originally created for testing Service Mesh. The server is meant to be really simple, but provides different output depending on how you start up the server.
## 🚀 Getting Started
The simplest way to get `color-svc` server started is the following:
```bash
$ docker run -it --rm \
-p 8800:8800 \
rytswd/color-svc:latest color-svc
# Output
2020/12/17 13:12:22 Server setup complete.
Per Request Delay: Disabled
Red : Enabled
Green : Enabled
Blue : Enabled
Yellow : Enabled
CORS : Disabled
Logging : Enabled
Total Available Colors: 15
2020/12/17 13:12:22 Server starting
...
# More log lines will appear as request is handled
```
With the server running, you can use the following:
```bash
$ curl 'http://localhost:8800/random'
# Output
Generated Color
"Green" - with HEX "#008000"
```
## 🚥 Available Endpoints
| Endpoint | Description |
| ---------------- | ------------------------------------------------------------------------------------------------- |
| `/random` | Generate random color, based on available color set |
| `/random/red` | Generate random redish color, returns error if disabled |
| `/random/green` | Generate random greenish color, returns error if disabled |
| `/random/blue` | Generate random bluish color, returns error if disabled |
| `/random/yellow` | Generate random yellowish color, returns error if disabled |
| `/SOME_COLOR` | Get specific color - `SOME_COLOR` is case insensitive, and when not found, you will get "unknown" |
## 🧪 Request Parameters
| Parameter | Description |
| ----------- | -------------------------- |
| `?fmt=json` | Return JSON representation |
## 🏁 How to use
With Docker
The simplest way to get started is the following:
```bash
$ docker run -it --rm \
-p 8800:8800 \
rytswd/color-svc:latest color-svc
```
You can adjust the behaviour with providing environmental variables. For example, the below command will only provide bluish colors.
```bash
$ docker run -it --rm \
-p 8800:8800 \
-e DISABLE_RED=true \
-e DISABLE_GREEN=true \
-e DISABLE_YELLOW=true \
rytswd/color-svc:latest color-svc
```
Also, the container is pushed to GitHub Container Registry at `ghcr.io/rytswd/color-svc`.
With Kubernetes
This repository contains example Kubernetes Service + Deployment YAMLs in [/k8s](k8s) directory.
You can use them as is, or adjust it as you like. There are some environmental variables that can adjust the server behaviours.
Example:
```bash
$ kubectl apply \
-f https://raw.githubusercontent.com/rytswd/color-svc/main/k8s/account.yaml \
-f https://raw.githubusercontent.com/rytswd/color-svc/main/k8s/color-svc-default.yaml
```
[k8s]: https://github.com/rytswd/color-svc/tree/main/k8s/
From code
Simply run with `go run cmd/server/main.go`. You can provide environmental variables to adjust some behaviours.
## ⚙️ Server Configurations
The following environmental variables are read when the server starts up.
| Env Name | Description | Default |
| ---------------------------- | -------------------------------------------------------------- | ------- |
| `ENABLE_DELAY` | Enable delay for all requests | false |
| `DELAY_DURATION_MILLISECOND` | Delay duration in millisecond, only used when delay is enabled | 1000 |
| `ENABLE_CORS` | Enable CORS | false |
| `DISABLE_LOGGING` | Disable per request logging | false |
| `DISABLE_RED` | Disable all redish colors | false |
| `DISABLE_GREEN` | Disable all greenish colors | false |
| `DISABLE_BLUE` | Disable all bluish colors | false |
| `DISABLE_YELLOW` | Disable all yellowish colors | false |