crime-data-api icon indicating copy to clipboard operation
crime-data-api copied to clipboard

Published 20 hours ago • verified publisher icon fbi-cde

WIP: Versioning the API

Open harrisj opened this issue 7 years ago • 4 comments

Fixes #140

The idea would be to move stuff into specific directories and either import from previous versions (base implmentations) or duplicate code for when an endpoint is changed from one version to the next.

harrisj avatar Jun 12 '17 18:06 harrisj

@cacraig: I haven't finished work on this (would want to try out with a v1 API, but how does this look generally?

harrisj avatar Jun 12 '17 18:06 harrisj

This looks good to me @harrisj - Versioning will be important moving forward. How do we want to name the routes? /beta/... or /v1/.... ?

cacraig avatar Jun 14 '17 15:06 cacraig

I was thinking we would keep the beta ones without a version to not break the CDE for now, but would try to move to /v1. Then we'd kill the beta version Two things:

  1. Should we wait until we remove some endpoints like TableFamily ones first before we attempt this?
  2. I'm not sure if it's better to copy endpoints to the new version or import them. It seems like we'd also need to have a versioned Swagger to test old and new versions work

harrisj avatar Jun 14 '17 15:06 harrisj

So I added some documentation to the README about this. Not sure if you all still like this approach. I'm thinking of disabling CodeClimate since this will mean more duplication

harrisj avatar Jul 03 '17 11:07 harrisj