openapi-json-schema-generator

(β˜… 177)

OpenAPI JSON Schema Generator allows auto-generation of API client libraries with a focus on JSON schema given an OpenAPI document

Showing a partial file list β€” download the zip above to see everything.

  • .dockerignore
  • .gitattributes
  • .gitignore
  • .gitmodules
  • Dockerfile
  • LICENSE
  • pom.xml
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/openapi-json-schema-tools/openapi-json-schema-generator

Downloads the entire project code from GitHub to your computer.

cd openapi-json-schema-generator

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run --rm -v "${PWD}:/local" openapijsonschematools/openapi-json-schema-generator-cli generate \

Runs the built image as an actual container.

./bin/run-in-docker.sh mvn package

Installs dependencies and builds the project using Maven.

./bin/run-in-docker.sh help # Executes 'help' command for openapi-json-schema-generator-cli

Type this command into your terminal and run it.

./bin/run-in-docker.sh list # Executes 'list' command for openapi-json-schema-generator-cli

Type this command into your terminal and run it.

./bin/run-in-docker.sh /gen/bin/python-petstore.sh # Builds the Python client

Runs the Python script (or module).

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Maven (Java)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
mvn clean install

Installs dependencies and builds the project using Maven.

mvn -Pstatic-analysis clean install

Installs dependencies and builds the project using Maven.

./bin/run-in-docker.sh mvn package

Installs dependencies and builds the project using Maven.

./run-in-docker.sh mvn clean install -U

Installs dependencies and builds the project using Maven.

mvn clean package

Installs dependencies and builds the project using Maven.

βœ… A BUILD SUCCESS message means it worked. The output is created under target/.

Pulled directly from this repo's README.

// repository documentation