GAPIC Showcase is an API that demonstrates Generated API Client (GAPIC) features and common API patterns used by Google. It follows the Cloud APIs design guide. This project provides a server and client implementation of the API that can be run locally over both gRPC and HTTP/JSON.
The GAPIC Showcase CLI can be installed using three different mechanisms: pulling a docker image from Google Container Registry, downloading the compiled binary from our our releases page, or simply by installing from source using go.
$ docker pull gcr.io/gapic-images/gapic-showcase:latest
$ docker run \
--rm \
-p 7469:7469/tcp \
-p 7469:7469/udp \
gcr.io/gapic-images/gapic-showcase:latest \
--help
> Root command of gapic-showcase
>
> Usage:
> gapic-showcase [command]
>
> Available Commands:
> completion Emits bash a completion for gapic-showcase
> echo This service is used showcase the four main types...
> help Help about any command
> identity A simple identity service.
> messaging A simple messaging service that implements chat...
> run Runs the showcase server
> testing A service to facilitate running discrete sets of...
>
> Flags:
> -h, --help help for gapic-showcase
> -j, --json Print JSON output
> -v, --verbose Print verbose output
> --version version for gapic-showcase
>
> Use "gapic-showcase [command] --help" for more information about a command.$ export GAPIC_SHOWCASE_VERSION=0.24.0
$ export OS=linux
$ export ARCH=amd64
$ curl -L https://github.com/googleapis/gapic-showcase/releases/download/v${GAPIC_SHOWCASE_VERSION}/gapic-showcase-${GAPIC_SHOWCASE_VERSION}-${OS}-${ARCH}.tar.gz | sudo tar -zx --directory /usr/local/bin/
$ gapic-showcase --help
...$ go install github.com/googleapis/gapic-showcase/cmd/gapic-showcase@latest
$ PATH=$PATH:`go env GOPATH`/bin
$ gapic-showcase --help
...* Bear in mind this is not a versioned installation so no versioning guarantees hold using this installation method.
The schema of GAPIC Showcase API can be found in schema/google/showcase/v1beta1 Its dependencies can be found in the googleapis/api-common-protos submodule.
To set up this repository for local development, follow these steps:
-
Install
protocfrom the protobuf release page or your OS package manager. This API utilizesproto3_optional, thusv3.12.0is the minimum supported version ofprotoc. -
Initialize the
api-common-protossubmodule:git submodule update --init --recursive
-
Install Go
- Linux:
sudo apt-get install golang - Mac, Windows, or other options: Please see the official set-up docs.
- Linux:
-
Clone this repository.
-
Set up Go protobuf tools:
go install github.com/golang/protobuf/protoc-gen-go go install github.com/googleapis/gapic-generator-go/cmd/protoc-gen-go_cli go install github.com/googleapis/gapic-generator-go/cmd/protoc-gen-go_gapic
-
Export the Go binaries to your environment path.
PATH=$PATH:`go env GOPATH`/bin
-
To compile the Showcase binary, as well as associated development utilities in this repository, run the following after you make changes:
go install ./...
If there are any changes to the protobuf files, the generated support code must be regenerated. This can be done by executing the following command:
go install ./util/cmd/... && go run ./util/cmd/compile_protos
If successful, you may see changes in the following directories:
server/genprotoserver/genrestclient/cmd/gapic-showcase
Then, update the binaries:
go install ./...
This quick start guide will show you how to start the server and make a request to it.
Run the showcase server to allow requests to be sent to it. This opens port :7469 to send and receive requests.
$ gapic-showcase run
> 2018/09/19 02:13:09 Showcase listening on port: :7469Open a new terminal window and make a request to the server.
$ gapic-showcase \
identity \ # Service name
create-user \ # Message name
--user.display_name Rumble \ # Request fields
--user.email [email protected]
> name:"users/0" display_name:"Rumble" email:"[email protected]" create_time:<seconds:1554414332 nanos:494679000 > update_time:<seconds:1554414332 nanos:494679000 >Note: You can make requests to this server from your own client but an insecure channel must be used since the server does not implement auth. Client library generators with Showcase-based integration tests need to provide the insecure channel to the client library in the tests.
Example for Node.js:
const grpc = require('@grpc/grpc-js');
const showcase = require('showcase');
const client = new showcase.EchoClient({ grpc, sslCreds: grpc.credentials.createInsecure() });Example for Go:
conn, err := grpc.Dial("localhost:7469", grpc.WithInsecure())
if err != nil {
log.Fatal(err)
}
opt := option.WithGRPCConn(conn)
client, err = showcase.NewEchoClient(context.Background(), opt)
if err != nil {
log.Fatal(err)
}Example for Java:
EchoSettings echoSettings = EchoSettings.newBuilder()
.setCredentialsProvider(NoCredentialsProvider.create())
.setTransportChannelProvider(
InstantiatingGrpcChannelProvider.newBuilder()
.setChannelConfigurator(
new ApiFunction<ManagedChannelBuilder, ManagedChannelBuilder>() {
@Override
public ManagedChannelBuilder apply(ManagedChannelBuilder input) {
return input.usePlaintext();
}
})
.build())
.build();
EchoClient echoClient = EchoClient.create(echoSettings);
GAPIC Showcase releases three main artifacts, a CLI tool, the gapic-showcase service protobuf files staged alongside its dependencies, and a protocol buffer descriptor set compiled from the gapic-showcase service protos.
Check out our releases page to see our released artifacts.
GAPIC Showcase follows semantic versioning. All artifacts that are released for a certain version are guaranteed to be compatible with one another.
Releases are made by release-please based on the contents of the Conventional Commits made to the project. Assets are then uploaded to the releases that are created.
GAPIC Showcase is supported for go versions 1.16 and later.
This API is not publicly served.
This is not an official Google product.