Jul 19

Openapi Spec development using Swagger Editor in Container

By Czapski Michael API-First Development, Software Development, Swagger No Comments »

It is possible to develop locally-hosted openapi Specifications using the on-line [Swagger Editor](https://editor.swagger.io/). The on-line Swagger Editor allows a specification to be uploaded from the browser’s host, edited and saved to the browser’s host.

It is also possible, and quite easy, to stand up a locally-hosted Swagger Editor, and eliminate the need to be on-line for this work.

The document referred to in this post describes the resources needed to create a locally-hosted Swagger Editor as a Docker Container, and describes the workflow, with illustrations.

See https://github.com/mwczapski/api_development_with_private_swagger_editor  for package artefacts.

Jul 19

Swagger Environment for API Design and Testing – Workflow

By Czapski Michael API-First Development, Development and Continuous Integration, Software Development, Swagger 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 document referred to in this post addresses the topic of creating and using an openapi-based API development and testing environment which uses complimentary Swagger Editor and Swagger Codegen Docker Containers.

Commands shown in the document pull the required Docker Images from the docker hub and create containers that use them.

Once the environment is up and running, API development and testing can be undertaken as required, and containers stopped and remove once the task is over. See https://github.com/mwczapski/Swagger_Development_Workflow for package artefacts.

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: • • • • • • • •
Jul 05

How to Use the Swagger Editor 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 use the Swagger Editor Image to rapidly spin up and begin to use the Docker container using that Image.

The intent of this document is to provide information on how to create a self-contained Docker container for API-First development using the mwczapski/swagger-editor:1.0.0 image hosted on Docker Hub, and to begin to use it.

The container provides the means to:

  • Run the Swagger Editor Server
  • Convert YAML specification documents to JSON and the vice versa

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

Tagged with: • • • • • • • • •
Jul 04

Swagger Editor 3.0 Docker Container

By Czapski Michael Personal 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 Editor 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 Editor (3.x) and OpenAPI (2 or 3).

The Image is the basis for a container that will have the means to:

  • Run the Swagger Editor Server
  • Convert YAML specification documents to JSON and the vice versa

The container is based on the latest Docker node image with extras.

The container uses:

  • Swagger Editor Distributable (swagger-editor-dist)
  • 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.
  • nodemon server
  • http-server server

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

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