gapic-generator

(β˜… 321)

Tools for generating API client libraries from API Service Configuration descriptions.

  • .gitignore
  • BUILD.bazel
  • build.gradle
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • dependencies.properties
  • DEVELOPMENT.md
  • gapic_generator.bzl
  • generate_clients.py
  • gradlew
  • gradlew.bat
  • LICENSE
  • license-header-javadoc.txt
  • README.md
  • renovate.json
  • repositories.bzl
  • repository_rules.bzl
  • SECURITY.md
  • settings.gradle
  • version.txt
  • WORKSPACE

# Installation Guide

1. Get the code
git clone https://github.com/googleapis/gapic-generator

Downloads the entire project code from GitHub to your computer.

cd gapic-generator

Moves into the project folder you just downloaded.

2. Maven (Java)

Medium Recommended
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.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd benchmark/clients/java/pubsub

This project's files live in a subfolder, so move into it first.

mvn clean install

Installs dependencies and builds the project using Maven.

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

3. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
./gradlew fatJar

Builds the project using Gradle.

./gradlew showGrpcJavaPluginPath

Builds the project using Gradle.

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

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd showcase/nodejs

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

5. PHP (Composer)

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • PHP A PHP runtime is required.
  • Composer The package manager used to install PHP libraries.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd benchmark/clients/php

This project's files live in a subfolder, so move into it first.

composer install

Installs the PHP libraries listed in composer.json.

βœ… Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

6. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd showcase/ruby

This project's files live in a subfolder, so move into it first.

bundle install

Installs the Ruby libraries listed in the Gemfile.

βœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
// repository documentation