Cloud Endpoints Portal
-
Endpoints Portal overview
Provides an overview of the Endpoints Portal, and includes a link to the Endpoints Portal demo website.
-
Getting started using the Endpoints Portal
Describes how to create a Endpoints Portal and introduces you to the Endpoints Portal user interface.
-
Updating SmartDocs
Describes the SmartDocs API reference documentation, how SmartDocs uses the fields in the
openapi.json
file created by Cloud Endpoints Frameworks to generate API documentation, and how to regenerate SmartDocs. -
Trying out the API
Describes how to configure your portal so that users can try out your API.
-
Adding custom documentation
Describes how to change the example Getting Started guide, and how to create and display additional documentation pages for your Endpoints Portal.
-
Syncing custom documentation through an API
Describes how to use an API to sync custom documentation to your portal.
-
Setting up a custom domain
Describes how to setup the Endpoints Portal to use a custom domain.
Managing API access
-
Overview of API access
Describes the API access control options available to you in Cloud Endpoints.
-
Controlling who can enable your API
Shows how to grant users permission to enable your API in their own Google Cloud project.
-
Enabling an API in your Google Cloud project
Shows how to enable an API in a Google Cloud project.
-
Granting and revoking access to the API
Describes the API access control options available to you in Endpoints.
Limiting API requests
Troubleshooting and monitoring
Managed service
-
Comparing configuration files
Describes the Deployment history tab on the Endpoints > Services page in the Google Cloud console, and how to compare a service configuration file with the previous version.
-
Getting the service name and configuration ID
Describes how to get the name and configuration ID of a managed service.
Frameworks guides - Java
-
Migrating to Endpoints Frameworks version 2.0
Describes migrating an existing Endpoints version 1.0 application to Endpoints Frameworks version 2.0.
-
Migrating Android projects to Endpoints Frameworks version 2.0
Describes migrating an existing Android Endpoints version 1.0 application to Endpoints Frameworks version 2.0.
-
About Endpoints Frameworks for Java
Describes the libraries and tools and provides other information to help you get started using Endpoints Frameworks for Java.
-
Setting up a development environment
Describes how to set up your development environment to build and deploy your backend API using Endpoints Frameworks for Java.
-
Using Guice with Endpoints Frameworks
Describes how to use Google Guice with an Endpoints Frameworks Java project.
-
Writing and annotating the code
Describes how to structure and annotate your Endpoints Frameworks code.
-
Deploying and testing an API
Shows how to deploy your API on Endpoints Frameworks.
-
Handling API versioning
Shows how create and deploy multiple versions of your API.
-
Using Apache Maven and the App Engine plugin
Explains how to manage an App Engine project for your Endpoints Frameworks API using Apache Maven,
-
Multiclass APIs
Shows how to create an API implemented in multiple classes for Endpoints Frameworks Java.
-
Adding API management
Shows how to add API management to your API.
-
Removing API management
Shows how to remove API management and delete the managed service for your API.
-
Restoring a managed service
Shows how to restore a managed service in case of accidental deletion.
-
Authenticating users
Shows how to add support in your API for user authentication from client applications using Endpoints Frameworks with Java.
-
Creating client IDs
Shows how to set up authorization to access your API backend.
-
Troubleshooting JWT validation
Provides troubleshooting information if JSON Web Token (JWT) validation fails.
-
Restricting API access with API keys
Shows how to create API keys and restrict API access using those keys.
-
Generating a client library
Shows how to generate a client library from your backend API.
-
Calling backend APIs from an Android app
Shows how an Android client calls a backend API built with Endpoints Frameworks.
Frameworks guides - Python
-
Migrating to Endpoints Frameworks version 2.0
Describes migrating an existing Endpoints version 1.0 app to Endpoints Frameworks version 2.0.
-
About Endpoints Frameworks with Python
Describes the libraries and tools and provides other information to help you get started using Endpoints Frameworks with Python.
-
Creating the API
Shows how to create an API for Endpoints Frameworks.
-
Creating an API implemented with multiple classes
Shows how to create an API implemented in multiple classes for Endpoints Frameworks.
-
Creating a web server
Shows how to define a web server for your API that you have created using Endpoints Frameworks.
-
Deploying and testing an API
Shows how to deploy and test your API.
-
Handling API versioning
Shows how to do versioning for your API and how to deploy to multiple versions.
-
Adding API management
Shows how to add API management support so that your API is fully supported by Endpoints.
-
Removing API management
Shows how to remove API management and delete the managed service for your API.
-
Restoring a managed service
Shows how to restore a managed service in case of accidental deletion.
-
Authenticating users
Shows how to add support in your API for user authentication from client applications using Endpoints Frameworks.
-
Creating client IDs
Shows how to obtain the required client IDs and supply them to the backend by using the proper API decorator argument.
-
Troubleshooting JWT validation
Provides troubleshooting information if the JWT validation fails and an error is returned in the response to the client.
-
Restricting access with API keys
Shows how to create API keys to restrict API access.
-
Generating client libraries
Shows how to generate a client library from your backend API.
-
Calling backend APIs from an Android App
Shows how to call a backend API from an Android app.
-
Accessing backend APIs from Python clients
Shows how to access an Endpoints API from a Python client.