add script to generate and update openapi3.0 docs

utils/ci-swagger.sh

@@ -1,33 +1,10 @@
 #!/bin/bash
 
-swagger2fileName="swagger2.yaml"
-openAPIspecfileName="gateway-swagger.yaml"
-
-fatal() {
-	echo "$@" >&2
-	exit 1
-}
-
-swagger generate spec -o "$swagger2fileName"
-
-if [ $? -ne 0 ]; then
-	fatal "could not generate swagger2.0 spec to the specified path, $swagger2fileName"
-fi
-
-swagger validate "$swagger2fileName"
-
-if [ $? -ne 0 ]; then
-	fatal "swagger spec is invalid... swagger spec is located at $swagger2fileName"
-fi
-
-api-spec-converter --from=swagger_2 --to=openapi_3 --syntax=yaml "$swagger2fileName" > "$openAPIspecfileName"
-
-if [ $? -ne 0 ]; then
-	fatal "could not convert swagger2.0 spec to opeenapi 3.0"
-fi
-
-## clean up
-rm "$swagger2fileName"
+ciUtilsDirectory=$(dirname "$0")
+source "$ciUtilsDirectory/generate-swagger.sh"
 
 ## Ideally, CI should push $openAPIspecfileName to GitHub
-## but for now, it can be committed by users and pushed alonside their changes.
+## but for now, `generate-swagger.sh` can be run by users locally and committed
+## then pushed alonside their changes.
+rm "$openAPIspecfileName"
+

utils/generate-swagger.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+
+
+swagger2fileName="swagger2.yaml"
+openAPIspecfileName="gateway-swagger.yaml"
+
+fatal() {
+	echo "$@" >&2
+	exit 1
+}
+
+mustExists() {
+	hash $1 > /dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		fatal "command not found: $1. Run $2"
+	fi
+}
+
+mustExists "swagger" "go get github.com/go-swagger/go-swagger/cmd/swagger"
+mustExists "api-spec-converter" "npm install -g api-spec-converter"
+
+swagger generate spec -o "$swagger2fileName"
+
+if [ $? -ne 0 ]; then
+	fatal "could not generate swagger2.0 spec to the specified path, $swagger2fileName"
+fi
+
+swagger validate "$swagger2fileName"
+
+if [ $? -ne 0 ]; then
+	fatal "swagger spec is invalid... swagger spec is located at $swagger2fileName"
+fi
+
+api-spec-converter --from=swagger_2 --to=openapi_3 --syntax=yaml "$swagger2fileName" > "$openAPIspecfileName"
+
+if [ $? -ne 0 ]; then
+	fatal "could not convert swagger2.0 spec to opeenapi 3.0"
+fi
+
+## clean up
+rm "$swagger2fileName"
+