Adding documentation

danielgerlag · May 3, 2020 · 9534d84 · 9534d84
1 parent f6761b3
commit 9534d84
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -6,6 +6,7 @@
 * [Activity Workers](#activity-api)
 * [Custom Steps](#steps-api)
 * [Diagnostics](#diagnostic-api)
+* [Swagger documentation](#swagger-documentation)
 
 Download the [Postman Collection](https://raw.githubusercontent.com/danielgerlag/conductor/master/docs/Conductor.postman_collection.json)
 
@@ -226,3 +227,14 @@ GET /api/step/<<id>>
 ```
 GET /api/info
 ```
+
+
+# Swagger Documentation
+
+It is possible to discover and try out API with [Swagger](https://swagger.io/) in a browser `https://localhost:5001/swagger`.
+
+![Swagger in browser](swagger_browser.png)
+
+It’s also convenient to import a Postman collection as swagger json `https://localhost:5001/swagger/v1/swagger.json`.
+
+![Import Posrmat collection](swagger_import.png)
diff --git a/docs/swagger_browser.png b/docs/swagger_browser.png
diff --git a/docs/swagger_import.png b/docs/swagger_import.png