Clarify the purpose of Makefile (#232)

pull/235/head
Hong Zhang 8 years ago committed by Jun Mukai
parent 6d0fba22a1
commit a23b2ef4d2
  1. 52
      README.md

@ -1,12 +1,11 @@
# Google APIs # Google APIs
This repository contains the original interface definitions for a This repository contains the original interface definitions of public
small (but growing) set of Google APIs built on a next-generation API Google APIs that support both REST and gRPC protocols. Reading the
serving stack. Reading the original interface definitions can provide original interface definitions can provide a better understanding of
a better understanding of these APIs and help you to utilize them more Google APIs and help you to utilize them more efficiently. You can also
efficiently. You can also use these interface definitions with open use these definitions with open source tools to generate client
source tools to generate client libraries or other artifacts such as libraries, documentation, and other artifacts.
documentation.
For more details on all Google APIs and developer tools, see the [Google For more details on all Google APIs and developer tools, see the [Google
Developers](https://developers.google.com/products/) site. Developers](https://developers.google.com/products/) site.
@ -15,21 +14,20 @@ Developers](https://developers.google.com/products/) site.
Google APIs are typically deployed as API services that are hosted Google APIs are typically deployed as API services that are hosted
under different DNS names. One API service may implement multiple APIs under different DNS names. One API service may implement multiple APIs
and multiple versions of the same API, and each API contains a and multiple versions of the same API.
collection of API methods.
Google APIs use [Protocol Buffers](https://github.com/google/protobuf)
By default, Google APIs use [Protocol version 3 (proto3) as their Interface Definition Language (IDL) to
Buffers](https://github.com/google/protobuf) language version 3 - aka define the API interface and the structure of the payload messages. The
proto3 - as their Interface Definition Language (IDL) to define the same interface definition is used for both REST and RPC versions of the
API interface and the structure of the payload messages. The same
interface definition is used for both REST and RPC versions of the
API, which can be accessed over different wire protocols. API, which can be accessed over different wire protocols.
There are two ways of accessing Google APIs: There are two ways of accessing Google APIs:
1. JSON over HTTP/1.1: You can access Google APIs directly using JSON 1. JSON over HTTP: You can access Google APIs directly using JSON
over HTTP/1.1, using Google-provided API or third-party API client over HTTP, using
libraries. [Google API client libraries](https://developers.google.com/api-client-libraries)
or third-party API client libraries.
2. Protocol Buffers over gRPC: You can access Google APIs published 2. Protocol Buffers over gRPC: You can access Google APIs published
in this repository through [GRPC](https://github.com/grpc), which is in this repository through [GRPC](https://github.com/grpc), which is
@ -39,8 +37,8 @@ streaming.
## Discussions ## Discussions
You may use the [Google APIs](https://groups.google.com/group/googleapis) Please use GitHub Issues to discuss bugs and features related to this
mailing list for general discussions about this repository. repository.
## Repository Structure ## Repository Structure
@ -53,19 +51,23 @@ client libraries have idiomatic namespaces in most programming
languages. Alongside the API directories live the configuration files languages. Alongside the API directories live the configuration files
for the [GAPIC toolkit](https://github.com/googleapis/toolkit). for the [GAPIC toolkit](https://github.com/googleapis/toolkit).
**NOTE:** the major version of an API is used to indicate breaking **NOTE:** The major version of an API is used to indicate breaking
change to the API. change to the API.
## Generate gRPC Source Code ## Generate gRPC Source Code
To generate gRPC source code for Google APIs in this repository, you To generate gRPC source code for Google APIs in this repository, you
first need to install both Protocol Buffers and gRPC on your local first need to install both Protocol Buffers and gRPC on your local
machine. Then you can run `make all` in this directory to generate machine, then you can run `make LANGUAGE=xxx all` to generate the
the code. source code. You need to integrated the generated source code into
your application build system.
**NOTE:** The Makefile is only intended to generate source code for the
entire repository. It is not for generating linkable client library
for a specific API. Please see other repositories under
https://github.com/googleapis for generating linkable client libraries.
### Go gRPC Source Code ### Go gRPC Source Code
It is difficult to generate Go gRPC source code from this repository, It is difficult to generate Go gRPC source code from this repository,
since Go has different directory structure. since Go has different directory structure.
Please use [this repository](https://github.com/google/go-genproto) instead. Please use [this repository](https://github.com/google/go-genproto) instead.
**NOTE:** The Makefile needs more improvements.

Loading…
Cancel
Save