Skip to content

Commit ea7f4fc

Browse files
committed
Add the swagger UI link to docs
1 parent e97c926 commit ea7f4fc

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Specifications:
1616
* Structured logging with zap
1717
* 12-factor app with viper
1818
* Fault injection (random errors and latency)
19+
* Swagger docs
1920
* Helm and Kustomize installers
2021
* End-to-End testing with Kubernetes Kind and Helm
2122

@@ -41,11 +42,14 @@ Web API:
4142
* `GET /store/{hash}` returns the content of the file /data/hash if exists
4243
* `GET /ws/echo` echos content via websockets `podcli ws ws://localhost:9898/ws/echo`
4344
* `GET /chunked/{seconds}` uses `transfer-encoding` type `chunked` to give a partial response and then waits for the specified period
45+
* `GET /swagger.json` returns the API Swagger docs, used for Linkerd service profiling and Gloo routes discovery
4446

4547
Web UI:
4648

4749
![podinfo-ui](https://raw.githubusercontent.com/stefanprodan/podinfo/gh-pages/screens/podinfo-ui.png)
4850

51+
To access the Swagger UI open `<podinfo-host>/swagger/index.html` in a browser.
52+
4953
### Guides
5054

5155
* [Automated canary deployments with Flagger and Istio](https://medium.com/google-cloud/automated-canary-deployments-with-flagger-and-istio-ac747827f9d1)

0 commit comments

Comments
 (0)