search

pacificclimate / scip-backend

Backend that serves salmon population data to the scip webpage
GNU Affero General Public License v3.0
0 stars 0 forks source link

support POST requests #10

Closed corviday closed 7 months ago

corviday commented 8 months ago

The PCEX backend was having difficulty with very long URLS - specifically, URLs containing a WKT string describing a complex area. We have updated the PCEX backend to accept parameters in the body of a POST request, which has no length limits.

Long parameter strings have not posed an issue on this backend, despite receiving the same long WKT strings, but we anticipate that they are likely to in the future due to deployment considerations like gunicorn, caches, or various user browsers, so I want to update it as well.

This backend previously accessed client-supplied URL parameters from flask's request.args, but I have switched it to the extremely convenient request.values, which includes both URL parameters and body parameters (provided they're supplied in JSON format) in a single dictionary, so the code doesn't have to know or care how the parameters arrive.

resolves #9

corviday commented 8 months ago

Demo is up at https://services.pacificclimate.org/dev/scip/api/

Sample cURL queries for reviewers:

# get request
curl https://services.pacificclimate.org/dev/scip/api/region?kind=basin

# post version of that request
curl -X POST https://services.pacificclimate.org/dev/scip/api/region -F "kind=basin"

# more complicated get request
curl https://services.pacificclimate.org/dev/scip/api/region?kind=watershed&overlap=%7B%22type%22:%22Polygon%22,%22coordinates%22:[[[-129.333758,54.01845],[-129.237571,53.94007],[-129.302505,53.812526],[-129.568949,53.684004],[-129.800021,53.796718],[-130.154431,54.171755],[-130.020845,54.197711],[-129.98958,54.289886],[-129.915654,54.251166],[-129.874539,54.266616],[-129.948923,54.387121],[-129.653546,54.560298],[-129.654467,54.623617],[-129.514375,54.584238],[-129.463207,54.64987],[-129.269288,54.651256],[-129.460205,54.650331],[-129.368807,54.77132],[-129.479748,54.819892],[-129.445026,54.877354],[-128.922033,54.950497],[-128.949108,55.022846],[-128.790617,55.119631],[-128.826323,55.200779],[-128.582201,55.108122],[-128.379393,55.140742],[-128.358816,55.199029],[-128.217744,55.181563],[-128.397646,55.226581],[-128.392113,55.387226],[-128.215213,55.421111],[-128.153239,55.496675],[-128.403599,55.67242],[-128.653247,55.745676],[-128.796815,55.866013],[-128.520862,56.08116],[-128.371845,56.026127],[-128.520381,56.081086],[-128.266846,56.106446],[-128.296599,56.239039],[-128.093454,56.31205],[-128.281028,56.406874],[-128.157916,56.452461],[-128.058585,56.412118],[-127.986903,56.520703],[-127.820176,56.563697],[-127.90585,56.618664],[-128.185291,56.647625],[-128.200492,56.745356],[-128.465859,56.790736],[-128.699336,56.886931],[-128.668013,56.962063],[-128.789539,57.055539],[-128.674104,57.168249],[-128.431463,57.047688],[-128.18471,57.184567],[-128.073713,57.120488],[-127.876984,57.122906],[-127.944792,57.179033],[-127.731769,57.294097],[-127.649813,57.214237],[-127.733835,56.998355],[-127.589839,56.999901],[-127.540121,56.944757],[-127.615905,56.900399],[-127.492622,56.772015],[-127.542235,56.708299],[-127.414618,56.681861],[-127.231798,56.738479],[-127.096859,56.608797],[-126.810731,56.672087],[-126.789782,56.76161],[-126.609692,56.783166],[-126.438971,56.659377],[-126.17532,56.636307],[-126.102054,56.525435],[-126.21835,56.477967],[-126.105394,56.442413],[-126.263866,56.301756],[-126.701958,56.269848],[-126.779214,56.247755],[-126.622768,56.055304],[-126.813767,56.017665],[-127.032683,56.199365],[-127.020315,56.054062],[-126.916264,55.998904],[-126.999053,56.001326],[-126.881376,55.96591],[-126.924227,55.91677],[-126.751707,55.742425],[-126.48002,55.640218],[-126.38595,55.535973],[-126.548147,55.481171],[-126.423136,55.519493],[-126.234721,55.372773],[-126.423485,55.367883],[-126.180416,55.158005],[-126.155912,55.015566],[-125.777007,54.795721],[-125.856838,54.721718],[-125.747023,54.603562],[-125.564382,54.608722],[-125.512152,54.528405],[-125.146048,54.546479],[-125.055452,54.478442],[-124.787118,54.534464],[-124.699932,54.486213],[-124.820695,54.364966],[-124.535455,54.236604],[-124.874088,54.207156],[-124.925021,54.242524],[-124.838559,54.282334],[-124.951125,54.319888],[-125.083555,54.255476],[-125.464875,54.244107],[-125.675377,54.295565],[-125.821138,54.438838],[-126.01381,54.510054],[-126.090184,54.351641],[-125.911233,54.170209],[-126.01185,54.11308],[-126.172866,54.21129],[-126.235423,54.182308],[-126.170624,54.104728],[-126.275045,54.104517],[-126.721763,54.225721],[-126.633148,54.362771],[-126.745547,54.410662],[-126.760602,54.410531],[-126.633148,54.362771],[-126.77863,54.257939],[-126.629639,54.060973],[-127.08431,54.080157],[-127.283834,53.896347],[-127.333985,53.735884],[-127.484112,53.770086],[-127.809479,53.65781],[-128.064178,53.902069],[-128.042873,54.001576],[-128.016476,54.011644],[-127.980717,54.211686],[-128.136908,54.297104],[-128.097689,54.371793],[-128.189748,54.39195],[-128.155819,54.377633],[-128.134578,54.320264],[-128.329774,54.354975],[-128.560364,54.289016],[-128.82309,54.306645],[-128.826378,54.295897],[-129.01283,54.247309],[-128.953449,54.101125],[-129.333758,54.01845]]]%7D

# POST version of more complicated request 
curl -X POST https://services.pacificclimate.org/dev/scip/api/region -F "kind=watershed" -F 'overlap={"type":"Polygon","coordinates":[[[-129.333758,54.01845],[-129.237571,53.94007],[-129.302505,53.812526],[-129.568949,53.684004],[-129.800021,53.796718],[-130.154431,54.171755],[-130.020845,54.197711],[-129.98958,54.289886],[-129.915654,54.251166],[-129.874539,54.266616],[-129.948923,54.387121],[-129.653546,54.560298],[-129.654467,54.623617],[-129.514375,54.584238],[-129.463207,54.64987],[-129.269288,54.651256],[-129.460205,54.650331],[-129.368807,54.77132],[-129.479748,54.819892],[-129.445026,54.877354],[-128.922033,54.950497],[-128.949108,55.022846],[-128.790617,55.119631],[-128.826323,55.200779],[-128.582201,55.108122],[-128.379393,55.140742],[-128.358816,55.199029],[-128.217744,55.181563],[-128.397646,55.226581],[-128.392113,55.387226],[-128.215213,55.421111],[-128.153239,55.496675],[-128.403599,55.67242],[-128.653247,55.745676],[-128.796815,55.866013],[-128.520862,56.08116],[-128.371845,56.026127],[-128.520381,56.081086],[-128.266846,56.106446],[-128.296599,56.239039],[-128.093454,56.31205],[-128.281028,56.406874],[-128.157916,56.452461],[-128.058585,56.412118],[-127.986903,56.520703],[-127.820176,56.563697],[-127.90585,56.618664],[-128.185291,56.647625],[-128.200492,56.745356],[-128.465859,56.790736],[-128.699336,56.886931],[-128.668013,56.962063],[-128.789539,57.055539],[-128.674104,57.168249],[-128.431463,57.047688],[-128.18471,57.184567],[-128.073713,57.120488],[-127.876984,57.122906],[-127.944792,57.179033],[-127.731769,57.294097],[-127.649813,57.214237],[-127.733835,56.998355],[-127.589839,56.999901],[-127.540121,56.944757],[-127.615905,56.900399],[-127.492622,56.772015],[-127.542235,56.708299],[-127.414618,56.681861],[-127.231798,56.738479],[-127.096859,56.608797],[-126.810731,56.672087],[-126.789782,56.76161],[-126.609692,56.783166],[-126.438971,56.659377],[-126.17532,56.636307],[-126.102054,56.525435],[-126.21835,56.477967],[-126.105394,56.442413],[-126.263866,56.301756],[-126.701958,56.269848],[-126.779214,56.247755],[-126.622768,56.055304],[-126.813767,56.017665],[-127.032683,56.199365],[-127.020315,56.054062],[-126.916264,55.998904],[-126.999053,56.001326],[-126.881376,55.96591],[-126.924227,55.91677],[-126.751707,55.742425],[-126.48002,55.640218],[-126.38595,55.535973],[-126.548147,55.481171],[-126.423136,55.519493],[-126.234721,55.372773],[-126.423485,55.367883],[-126.180416,55.158005],[-126.155912,55.015566],[-125.777007,54.795721],[-125.856838,54.721718],[-125.747023,54.603562],[-125.564382,54.608722],[-125.512152,54.528405],[-125.146048,54.546479],[-125.055452,54.478442],[-124.787118,54.534464],[-124.699932,54.486213],[-124.820695,54.364966],[-124.535455,54.236604],[-124.874088,54.207156],[-124.925021,54.242524],[-124.838559,54.282334],[-124.951125,54.319888],[-125.083555,54.255476],[-125.464875,54.244107],[-125.675377,54.295565],[-125.821138,54.438838],[-126.01381,54.510054],[-126.090184,54.351641],[-125.911233,54.170209],[-126.01185,54.11308],[-126.172866,54.21129],[-126.235423,54.182308],[-126.170624,54.104728],[-126.275045,54.104517],[-126.721763,54.225721],[-126.633148,54.362771],[-126.745547,54.410662],[-126.760602,54.410531],[-126.633148,54.362771],[-126.77863,54.257939],[-126.629639,54.060973],[-127.08431,54.080157],[-127.283834,53.896347],[-127.333985,53.735884],[-127.484112,53.770086],[-127.809479,53.65781],[-128.064178,53.902069],[-128.042873,54.001576],[-128.016476,54.011644],[-127.980717,54.211686],[-128.136908,54.297104],[-128.097689,54.371793],[-128.189748,54.39195],[-128.155819,54.377633],[-128.134578,54.320264],[-128.329774,54.354975],[-128.560364,54.289016],[-128.82309,54.306645],[-128.826378,54.295897],[-129.01283,54.247309],[-128.953449,54.101125],[-129.333758,54.01845]]]}'