Jul 12

How to Use the Swagger Codegen 3.0 Docker Container

By Czapski Michael Development and Continuous Integration No Comments »

Among other activities, I design and implement RESTful APIs. I use the VSCode, the Swagger Editor, the Swagger UI and the Swagger Codegen, or a combination, as needed. I also use Docker for containerisation as much as possible because I dislike burdening my host machine with all manner of software and the resulting need to manage versions, version conflicts, etc..

The intent of the document is to provide a reader with the means to create a self-contained Docker container for generating and running back-end stubs based on an openapi.yaml specification for API-First development based on the Docker Image at https://hub.docker.com/repository/docker/mwczapski/swagger_codegen.

The container will have the means to:

  • Use the Swagger Codegen to generate and run NodeJS stubs (and Java8 stubs, and Bash stubs) to facilitate API testing
  • Convert YAML specification documents to JSON and the vice versa

Please see https://github.com/mwczapski/Swagger_Codegen_3_Docker_Container for package artefacts.

Tagged with: • • • • • • • •
Jul 11

Swagger Codegen 3.0 Docker Container

By Czapski Michael Development and Continuous Integration No Comments »

Among other activities, I design and implement RESTful APIs. I use the VSCode, the Swagger Editor, the Swagger UI and the Swagger Codegen, or a combination, as needed. I also use Docker for containerisation as much as possible because I dislike burdening my host machine with all manner of software and the resulting need to manage versions, version conflicts, etc..

To help myself, and others, I documented the steps necessary to create a Docker Image to host the Swagger Codegen so that Docker container using that Image can be spun up as needed in seconds and destroyed as quickly when no longer required. The intent of the document is to provide a set of steps that a reader can use to create a self-contained Docker container for API-First development using latest Swagger Codegen (3.x) and OpenAPI (2 or 3). The intent of the image is to provide a reader with the means to create a self-contained Docker container for generating and running back-end stubs based on an openapi.yaml specification for API-First development. 

The container will have the means to:

  • Use the Swagger Codegen to generate and run NodeJS stubs (and Java8 stubs, and Bash stubs) to facilitate API testing
  • Convert YAML specification documents to JSON and the vice versa

The image is based on the latest Docker node image with extras as discussed herein.

The image uses:

  • `swagger-codegen-cli/3.0.20` to support YAML to JSON conversion and generation of client and server stubs based on the OpenAPI Specification / Swagger file for supported languages. `swagger-codegen-cli` requires Java 8, which is installed during container setup.
  • `sqlite3`
  • `nodemon` server
  • `http-server` server

Please see https://github.com/mwczapski/Swagger_Codegen_3_Docker_Container for package artefacts.

Tagged with: • • • • • • • •
May 24

Git Docker Container for VS Code Remote Container development

By Czapski Michael Development and Continuous Integration No Comments »

I find VS Code to be a great free development editor and my activities involve a deal of development for the Linux platform. I like to be able to run the editor on Windows and build and run in the target environments using Docker as means to spin up lightweight containers for different projects with different technology stacks.

Scripts in this package facilitate creation of a Docker Container, based on the docker image created using scripts in the package Git Client Docker Container, with a Git Client that you can choose to configure to work in conjunction with the Private GIT Server. This container can be configured to work as a remote container environment for VS Code development on Windows. Please see  https://github.com/mwczapski/windows_vscode_development_in_linux_docker_container for RAEADME and package artifacts.

Tagged with: • • • • • • • • • • • •
May 18

Creating Git Client as a Docker Container

By Czapski Michael Development and Continuous Integration No Comments »

The package named in this article provides detailed steps for creating a Docker Container that runs a git client.

Scripts in this package facilitate creation of a Docker Image and a Docker Container with a Git Client that can be used with, or to test, the private GIT Server. The image uses the git distribution from the Debian Jesse repository. The container can be used as the basis for a development environment, upon which to build a development environment with the appropriate tools like NodeJS, Java, etc..

The image is based on bitnami/minideb:jessie image as at early May 2020.

The image is 156MB in size.

The image will be saved as the gitclient:1.0.0 Docker Image if the 01_create_git_client_baseline_image.sh script is run from the …./gitclient/_commonUtils directory and, if the user requests it, will also be uploaded to a remote docker repository, which must be defined. Please see https://github.com/mwczapski/git_client_docker_container for RAEADME and package artifacts.

Tagged with: • • • • • • • • •
preload preload preload