Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yesinteractive/dadjokes
Dadjokes.online: Microservice echo-service as an alternative to httpbin for testing k8s, docker, kong, istio, kuma, etc. Built on FSL php microframework. Who says testing and dev ops can't be fun?
https://github.com/yesinteractive/dadjokes
api api-gateway apigee dad-jokes dev devops docker echo-server httpbin istio jokes k8s kong kubernetes kubernetes-deployment kuma microservice mulesoft php service-mesh
Last synced: 12 days ago
JSON representation
Dadjokes.online: Microservice echo-service as an alternative to httpbin for testing k8s, docker, kong, istio, kuma, etc. Built on FSL php microframework. Who says testing and dev ops can't be fun?
- Host: GitHub
- URL: https://github.com/yesinteractive/dadjokes
- Owner: yesinteractive
- License: mit
- Created: 2020-01-15T20:51:44.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-03T12:22:37.000Z (9 months ago)
- Last Synced: 2024-08-04T09:07:40.682Z (3 months ago)
- Topics: api, api-gateway, apigee, dad-jokes, dev, devops, docker, echo-server, httpbin, istio, jokes, k8s, kong, kubernetes, kubernetes-deployment, kuma, microservice, mulesoft, php, service-mesh
- Language: PHP
- Homepage: http://dadjokes.online
- Size: 4.55 MB
- Stars: 100
- Watchers: 8
- Forks: 26
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Dad Jokes Microservice #
[](https://hub.docker.com/r/yesinteractive/dadjokes)
[](https://github.com/yesinteractive/dad-jokes_microservice)
[](https://github.com/yesinteractive/dad-jokes_microservice)
Just a sample microservice or echo service used for testing API Gateways such as Kong, Kubernetes K8s, Openshift, Docker,
Service meshes such as Kuma or Istio, etc. as an alternative to httpbin. Feel free
to [add your own jokes](https://github.com/yesinteractive/dadjokes/blob/master/controllers/jokes.txt)
to this repo as well. In addition to a dad joke, the service will automatically echo back information about the
incoming request. This is helpful for testing and troubleshooting. If you wish to not display echo back the request
data, then just make the request against the `/noecho` endpoint or by configuring the dadjokes service with the noecho environment variable set to true.
## Hosted Service / Demo ##
Access [http://dadjokes.online](http://dadjokes.online) to see the service in action.
## Usage ##
**Endpoint URI** : `/`
**Method** : `GET` `POST` `PUT` `PATCH` `DELETE`
**Parameters** : optional
**Successful Response** : `200 OK`
```json
"Joke": {
"Opener": "I burned 2000 calories today",
"Punchline": "I left my food in the oven for too long.",
"Processing Time": "0.001223"
},
"RequestEcho": {
"Headers": {
"Host": "dadjokes.online",
"Connection": "keep-alive",
"X-Forwarded-For": "74.11.135.11",
"X-Forwarded-Proto": "http",
"X-Forwarded-Host": "dadjokes.online",
"X-Forwarded-Port": "80",
"X-Real-IP": "74.11.135.11",
"Cache-Control": "max-age=0",
"Upgrade-Insecure-Requests": "1",
"User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.61 Safari/537.36",
"Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
"Accept-Encoding": "gzip, deflate",
"Accept-Language": "en-US,en;q=0.9",
"Cookie": "fsl=eijse8smkrfce80or4frpjnf87"
},
"Method": "GET",
"Origin": "192.11.166.11",
"URI": "/echo",
"Arguments": {
"uri": "/echo"
},
"Data": "",
"URL": "http://dadjokes.online/echo"
}
}
```
### DISABLING THE ECHO FEATURE ###
To disable the echoing of in the incomfing response, simply add the docker environment variable `DADJOKES_NOECHO=TRUE` to your configuration or simply use the `\noecho` endpoint in
the first level of your request calls. For example:
**Endpoint URI** : `/noecho/abc/efg/`
**Method** : `GET` `POST` `PUT` `PATCH` `DELETE`
**Parameters** : optional
**Successful Response** : `200 OK`
```json
{
"Jokes": {
"Opener": "What did the mountain climber name his son?",
"Punchline": "Cliff",
"Processing Time": "0.001530"
}
}
```
## Installation ##
### Deployment Examples ###
See usage examples for Kubernetes, Kong for Kubernetes Ingress Controller, and docker-compose in the [examples directory folder.](https://github.com/yesinteractive/dad-jokes_microservice/blob/master/examples)
### With Docker ###
Docker image is Alpine 3.11 based running PHP 7.3 on Apache. The containter exposes both ports 8100 (HTTP) an 8143 (HTTPS) with a self signed certificated. If you wish to alter the container configuration, feel free to use the Dockerfile in this repo (https://github.com/yesinteractive/dad-jokes_microservice/blob/master/Dockerfile). Otherwise, you can pull the latest image from DockerHub with the following command:
```
docker pull yesinteractive/dadjokes
```
Typical basic usage (below example exposes dadjokes on host ports 8100 and 8143):
```
$ docker run -d \
-p 8100:8100 \
-p 8143:8143 \
-e DADJOKES_NOECHO=FALSE \
yesinteractive/dadjokes
```
Typical usage in Dockerfile:
```
FROM yesinteractive/dadjokes
RUN echo
```