Version 2.3.3

Jean-Beru · Nov 6, 2019 · e2cca5e · e2cca5e
1 parent c271d5c
commit e2cca5e
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 62 deletions.
diff --git a/.gitignore b/.gitignore
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,7 @@
+FROM node:13-alpine
+
+ENV SWAGGER_CLI_VERSION 2.3.3
+
+RUN npm install -g swagger-cli@${SWAGGER_CLI_VERSION}
+
+CMD ["swagger-cli", "-h"]
diff --git a/README.md b/README.md
@@ -1 +1,22 @@
-# docker-swagger-cli
+# Swagger/OpenAPI CLI image
+
+Docker image for [Swagger CLI](https://github.com/APIDevTools/swagger-cli).
+
+It allows you to validate Swagger files or bundle them into a combined file.
+
+## Use it
+
+See help.
+```shell script
+docker run --rm jeanberu/swagger-cli 
+```
+
+Validate schema from URL or a file.
+```shell script
+docker run --rm jeanberu/swagger-cli swagger-cli validate YOUR_URL
+docker run --rm jeanberu/swagger-cli swagger-cli validate YOUR_FILE
+```
+
+## More help ?
+
+See https://github.com/APIDevTools/swagger-cli for further information.