diplicity
A dippy API service based on App Engine and godip.
Public host
A regularly updated service running this code is available at https://diplicity-engine.appspot.com/.
Play the game
To play, either be brave and use the auto generated HTML UI at https://diplicity-engine.appspot.com/, or use one of the client projects:
Architecture
The API uses a slightly tweaked HATEOAS style, but is basically JSON/REST.
Auto generated HTML UI
To enable exploration of the API for debugging, research by UI engineers or even playing (not for the faint of heart) the API delivers a primitive HTML UI when queried with Accept: text/html
.
Forcing JSON output
To enable debugging the JSON output in a browser, adding the query parameter accept=application/json
will make the server output JSON even to a browser that claims to prefer text/html
.
Running locally
To run it locally
- Clone this repo.
- Install the App Engine SDK for Go.
- Make sure your
$GOPATH
is set to something reasonable, like$HOME/go
. - Run
go get -v ./...
in the root directory. - Run
go get -v -u github.com/gorilla/sessions
. I have no idea why, but for some reasongithub.com/gorilla/context
won't get downloaded automatically by the previous command, while this one does download it... - Run
dev_appserver.py .
in theapp
directory. - Run
curl -XPOST http://localhost:8080/_configure -d '{"FCMConf": {"ServerKey": SERVER_KEY_FROM_FCM}, "OAuth": {"ClientID": CLIENT_ID_FROM_GOOGLE_CLOUD_PROJECT, "Secret": SECRET_FROM_GOOGLE_CLOUD_PROJECT}, "SendGrid": {"APIKey": SEND_GRID_API_KEY}}'
.- This isn't necessary to run the server per se, but
FCMConf
is necessary for FCM message sending,OAuth
is necessary for nonfake-id
login, andSendGrid
is necessary for email sending.
- This isn't necessary to run the server per se, but
Faking user ID
When running the server locally, you can use the query parameter fake-id
to set a fake user ID for your requests. This makes it possible and easy to test interaction between users without creating multiple Google accounts or even running multiple browsers.
Faking user email
When running the server locally, you can also use the query parameter fake-email
to set the fake email of the fake user ID. This makes it possible and easy to test the email notification system.
Running the tests
To run the tests
- Start the local server with a clean database and consistent datastore. Since the tests don't wait around for consistency to be achieved, this simplifies writing the tests. Run
dev_appserver.py --clear_datastore=yes --datastore_consistency_policy=consistent .
in theapp
directory. - Run
go test -v
in thediptest
directory.