API Design Notes

[tlake]

Meta

This issue is not intended to outline a body of work and then be closed when that item is merged. Instead, I figured that it could be used as a sort of discussion forum. We can hold discussions in comments below, and then update and maintain this comment as a source of truth for the design decisions. We can also use this issue as a source from which we can spin off actual work-item issues.

I'm open to alternatives if someone has a better thought. :)

Design

[tlake]

I think that the proof-of-concept work I've done in the django-dungeonbot repo is a great start here (of course, feel free to challenge that). It could use some updating, but there's a starting point for the API there, and at least the roll endpoint has been fleshed out with a nice browsable RESTful API. If we like that, one action item that we could get started with is porting over the issues from django-dungeonbot into this repository. Those issues contain some pretty solid descriptions of the various endpoints that the API should have, I think.

It's a little bit of a meta issue, but we could spin up an issue here for porting the django-dungeonbot issues into this dungeonbot-api repo.

[tlake]

Also, it should probably be stated somewhere, but I'm excited to use some latest-version stuff here. Let's have some fun with new things! Python 3.6, Django 2.0, DRF 3.0, etc.