include invocation for swagger-ui tool (#17)

* include invocation for swagger-ui tool

* fix readme

Author: tanmaykm

README.md

@@ -1,6 +1,6 @@
 # OpenAPI
 
-[![Build Status](https://github.com/JuliaComputing/OpenAPI.jl/workflows/CI/badge.svg)](https://github.com/JuliaComputing/OpenAPI.jl/actions?query=workflow%3ACI+branch%3Amaster)
+[![Build Status](https://github.com/JuliaComputing/OpenAPI.jl/workflows/CI/badge.svg)](https://github.com/JuliaComputing/OpenAPI.jl/actions?query=workflow%3ACI+branch%3Amain)
 [![codecov.io](http://codecov.io/github/JuliaComputing/OpenAPI.jl/coverage.svg?branch=main)](http://codecov.io/github/JuliaComputing/OpenAPI.jl?branch=main)
 
 This is the Julia library needed with code generated by the [OpenAPI generator](https://openapi-generator.tech/).
@@ -208,6 +208,28 @@ The Petstore is a common example that most OpenAPI implementations use to test a
     - Client: [docs](test/client/petstore_v3/petstore/README.md), [implementation](test/client/petstore_v3)
     - Server: [docs](test/server/petstore_v3/petstore/README.md), [implementation](test/server/petstore_v3)
 
+## Swagger UI
+
+[Swagger UI](https://swagger.io/tools/swagger-ui/) allows visualization and interaction with the API’s resources without having any of the implementation logic in place. OpenAPI.jl includes convenience methods to launch Swagger UI from Julia.
+
+Use `OpenAPI.swagger_ui` to open Swagger UI. It uses the standard `swaggerapi/swagger-ui` docker image and requires docker engine to be installed.
+
+```julia
+OpenAPI.swagger_ui(
+    spec::String;           # the OpenAPI specification to use
+    port::Int=8080,         # port to use 
+    use_sudo::Bool=false    # whether to use sudo while invoking docker
+)
+```
+
+To stop the Swagger UI container, use `OpenAPI.stop_swagger_ui`.
+
+```julia
+OpenAPI.stop_swagger_ui(;
+    use_sudo::Bool=false    # whether to use sudo while invoking docker
+)
+```
+
 ## TODO
 
 Not all OpenAPI features are supported yet, e.g.:

codecov.yml

@@ -0,0 +1,2 @@
+ignore:
+  - "src/tools.jl"

src/OpenAPI.jl

@@ -11,5 +11,6 @@ include("val.jl")
 include("json.jl")
 include("client.jl")
 include("server.jl")
+include("tools.jl")
 
 end # module

src/tools.jl

@@ -0,0 +1,52 @@
+const SWAGGER_UI_IMAGE = "swaggerapi/swagger-ui"
+
+docker_cmd(; use_sudo::Bool=false) = use_sudo ? `sudo docker` : `docker`
+
+function stop_swagger_ui(; use_sudo::Bool=false)
+    docker = docker_cmd(; use_sudo=use_sudo)
+    find_cmd = `$docker ps -a -q -f ancestor=$SWAGGER_UI_IMAGE`
+    container_id = strip(String(read(find_cmd)))
+    
+    if !isempty(container_id)
+        stop_cmd = `$docker stop $container_id`
+        stop_res = strip(String(read(stop_cmd)))
+
+        if stop_res == container_id
+            @debug("Stopped Swagger UI container")
+        elseif isempty(stop_res)
+            @debug("Swagger UI container not running")
+        else
+            @error("Failed to stop Swagger UI container: $stop_res")
+            return false
+        end
+
+        container_id = strip(String(read(find_cmd)))
+        if !isempty(container_id)
+            rm_cmd = `$docker rm $container_id`
+            rm_res = strip(String(read(rm_cmd)))
+
+            if rm_res == container_id
+                @debug("Removed Swagger UI container")
+            elseif isempty(rm_res)
+                @debug("Swagger UI container not found")
+            else
+                @error("Failed to remove Swagger UI container: $rm_res")
+                return false
+            end
+        end
+
+        return true
+    else
+        @debug("Swagger UI container not found")
+    end
+
+    return false
+end
+
+function swagger_ui(spec::String; port::Int=8080, use_sudo::Bool=false)
+    docker = docker_cmd(; use_sudo=use_sudo)
+    stop_swagger_ui(; use_sudo=use_sudo)
+    cmd = `$docker run -d --rm -p $port:8080 -e SWAGGER_JSON=/tmp/spec.json -v $spec:/tmp/spec.json $SWAGGER_UI_IMAGE`
+    run(cmd)
+    return "http://localhost:$port"
+end