This sample demonstrates how to use Google Cloud Endpoints with a Ruby backend. This sample requires that you have Ruby 2.0.0 or newer installed.

For a complete walkthrough showing how to run this sample in different environments, see the Google Cloud Endpoints Quickstarts.

This sample consists of two parts:

1. The backend
2. The clients

Install all the dependencies:

$ bundle install

Run the application:

$ bundle exec ruby app.rb -p 8080

With the app running locally, you can execute the simple echo client using:

$ bundle exec ruby clients/echo_client.rb \
    --host http://localhost:8080 \
    --api_key APIKEY \
    --message "message to echo"

The APIKEY doesn't matter as the endpoint proxy is not running to do authentication.

See the Google Cloud Endpoints Quickstarts.

With the project deployed, you'll need to create an API key to access the API.

1. Open the Credentials page of the API Manager in the Cloud Console.
2. Click 'Create credentials'.
3. Select 'API Key'.
4. Choose 'Server Key'

With the API key, you can use the echo client to access the API:

$ bundle exec ruby clients/echo_client.rb \
    --host https://YOUR-PROJECT-ID.appspot.com \
    --api_key YOUR-API-KEY \
    --message "message to echo"

The JWT client demonstrates how to use service accounts to authenticate to endpoints. To use the client, you'll need both an API key (as described in the echo client section) and a service account. To create a service account:

1. Open the Credentials page of the API Manager in the Cloud Console.
2. Click 'Create credentials'.
3. Select 'Service account key'.
4. In the 'Select service account' dropdown, select 'Create new service account'.
5. Choose 'JSON' for the key type.

To use the service account for authentication:

1. Update the google_jwt's x-google-jwks_uri in openapi.yaml with your service account's email address.
2. Redeploy your application.

Now you can use the JWT client to make requests to the API:

$ bundle exec ruby clients/google_jwt_client.rb \
    --host https://YOUR-PROJECT-ID.appspot.com \
    --api_key YOUR-API-KEY \
    --service_account_file /path/to/service-account.json

The ID Token client demonstrates how to use user credentials to authenticate to endpoints. To use the client, you'll need both an API key (as described in the echo client section) and a OAuth2 client ID. To create a client ID:

1. Open the Credentials page of the API Manager in the Cloud Console.
2. Click 'Create credentials'.
3. Select 'OAuth client ID'.
4. Choose 'Other' for the application type.

To use the client ID for authentication:

1. Update the /auth/info/googleidtoken's audiences in openapi.yaml with your client ID.
2. Redeploy your application.

Now you can use the client ID to make requests to the API:

$ bundle exec ruby clients/google_id_token_client.rb \
    --host https://YOUR-PROJECT-ID.appspot.com \
    --api_key YOUR-API-KEY \
    --client_secrets_file /path/to/client_secrets.json

The Swagger UI is an open source Swagger project that allows you to explore your API through a UI. Find out more about it on the Swagger site.