on 2835fc2 help sign in

A comprehensive Google Services SDK for Haskell.

git clone ssh://git.iko.soy/gogol

Gogol

Warning: This is an experimental prototype/preview release which is still under heavy development and not intended for public consumption, caveat emptor!

Build Status Hackage Version Gitter Chat

Description

Гоголь-моголь Мико́ла Васи́льович Го́голь

Generate New API Endpoints

To generate new API endpoints, use the gogol/gen directory. The key files in this directory (outside of the actual gogol-gen source!) are the annex files.

To add a new endpoint, first create its annex file in the annex directory. It should be named after the API endpoint as found in the google/google-api-go-client repo.

Example:

Generating the Cloud Dataproc API

The Cloud Dataproc API is called dataproc-api.json in the Google Discovery API. Create the file ./gen/annex/dataproc.json with these contents:

{
 "library": "dataproc",
 "canonicalName": "Dataproc"
}

From the ./gen directory, run:

make clean
make

This will build the ./gen/bin/gogol-gen executable, and then will generate libraries for all APIs that have matching ./gen/annex/*.json configuration.

Once completed, the result would be a ./gogol-dataproc directory containing the generated API client.

make full-clean can be used to cause a complete re-download of all (including new) service models.

Individual libraries can be generated by passing a specific MODELS environment variable to the make command, for example: MODELS=model/admin/directory/v1/admin-api.json make

Contribute

For any problems, comments, or feedback please create an issue here on GitHub.

Licence

Gogol is released under the Mozilla Public License Version 2.0.