Documentation: add document on the dex API #652
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ericchiang
force-pushed
the
dev-docs-api
branch
2 times, most recently
from
08b1cd0
to
cf79f10
Compare
ericchiang
changed the title
ericchiang
force-pushed
the
dev-docs-api
branch
from
cf79f10
to
eb02cb1
Compare
|
@ElijahCaine ptal |
pop
reviewed
Oct 31, 2016
|
|
||
| ## Generating clients | ||
|
|
||
| gRPC is a suite of tools for generating client and server bindings from a common declarative language. The canonical schema for dex's API can be found in the source tree at `api/api.proto`. Go bindings are generated and maintained in the same directory for internal use. |
There was a problem hiding this comment.
I would make api/api.proto a link to the file on GitHub for convenience.
Most readers will expect that reference to be linked.
| To generate a client for your own project install [`protoc`][protoc], install a protobuf generator for your project's language, and download the `api.proto` file. An example for a Go project: | ||
|
|
||
| ``` | ||
| # Install protoc-gen-go. |
There was a problem hiding this comment.
If these are shell commands they should begin with $. If it's a script make that clear. I like annotating it like this:
script-name.sh:
# script contents
...
But anything that makes it clear works for me.
| protoc --go_out=import_path=dexapi:. api.proto | ||
| ``` | ||
|
|
||
| Client programs can them be written using the generated code. A Go client which uses dex's internally generated code might look like the following: |
There was a problem hiding this comment.
Client programs can then be written [...]
|
|
||
| Between v1 and v2, dex switched from REST to gRPC. This largely stemmed from problems generating documentation, client bindings, and server frameworks that adequately expressed REST semantics. While [Google APIs][google-apis], [Open API/Swagger][open-api], and [gRPC Gateway][grpc-gateway] were evaluated, they often became clunky when trying to use specific HTTP error codes or complex request bodies. As a result, v2's API is entirely gRPC. | ||
|
|
||
| Many of arguments _against_ gRPC cite short term convenience rather than production use cases. Though this is a recognized shortcoming, dex already implements many features for developer convenience. For instance, users who wish to manually edit clients during testing can use the `staticClients` config field instead of the API. |
There was a problem hiding this comment.
Many arguments against (get rid of of).
ericchiang
force-pushed
the
dev-docs-api
branch
from
eb02cb1
to
fe1d275
Compare
|
changes addressed. thanks |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.