codeforboston / flagging

Flagging website for CRWA
MIT License
4 stars 12 forks source link

RESTful API #20

Closed dwreeves closed 4 years ago

dwreeves commented 4 years ago

Turn the model output into a RESTful API. We will want to do this eventually to assist in integration with the CRWA's Weebly site.

Here are the steps:

  1. Define an appropriate schema for the JSON output.
  2. Make the model output according to that schema.
  3. Stick it on the website.

There are three ways to do this:

dwreeves commented 4 years ago

Update on this: the FastAPI suggestion is impractical and silly when I rethink about it. FastAPI is great, but I don't think it makes sense to implement basically a whole different web framework on top of our app.

I think the "bare bones solution" is the best approach, but in addition we should implement semi-automated documentation using a framework like flasgger.

edsun123 commented 4 years ago

Working with Cameron on this.