search

miami-open-211 / developer-portal-v1.2

This is the v1.2 version of the portal.
http://miami.open.211.developer.adopta.agency/
0 stars 1 forks source link

Endpoints require trailing / #6

Open switzersc opened 5 years ago

switzersc commented 5 years ago

I was playing round with the open 211 miami API last week and discovered that you must add the trailing slash "/" to the URL in order for the request to be successful (and return a response).

For example

http://miami.open.211.hsda.api.adopta.agency/locations/full/

works but

http://miami.open.211.hsda.api.adopta.agency/locations/full

does not work.

I would consider this a bug. I don't think I've ever interacted with an API or website where a trailing / is required to access the endpoint, and it wouldn't occur to me that my requests would fail without that slash (indeed, it took me a couple days of occasional tinkering to figure out why some of my requests were working and others weren't). It wouldn't surprise me if there's an RFC about this somewhere... ^.^

kinlane commented 5 years ago

Hey now...yeah, if I recall this was a weird AWS API Gateway thing? IDK. Will revisit.

While I agree with you, and push this to be the expected behavior....I have had argument with RESTafarians about these technically being two different resources. The slash making them distinctly different. But in the end I don't care about that...... will push as behavior when I get the time.

Thank yoU!

switzersc commented 5 years ago

I have had argument with RESTafarians about these technically being two different resources

Whaa?! What's the reasoning there?

kinlane commented 5 years ago

LOL.

That . http://miami.open.211.hsda.api.adopta.agency/locations/full/

Is technically a different resource than http://miami.open.211.hsda.api.adopta.agency/locations/full

Two separate resources because of the slash.....

I'm not defending it.....just repeating the challenges I've had on the subject. ;-)

switzersc commented 5 years ago

Ha! I mean, I agree they're technically different strings and therefore different locations, but in practice... Anyway, I would not say no to an RFC that proposed the trailing slashes don't have semantic (or literal) value and therefore url/ == url and are the same location. I'll try to see if there is one and if not, who knows, this might be my big cause for 2019 😆

kinlane commented 5 years ago

100% agreed. I assumed it was a standard practice to just interpret equally or append....

I had gotten used to folks arguing dumb stuff with me....and this was just one more in the queue...

:-)

greggish commented 5 years ago

Thank y'all for tooling around on this. While you're here, i wonder if there's any other suggestions you have for how to improve the Miami Open211 api demo.

I've had a couple of folks look at it and report back that it wasn't working for them, although i didn't get specifics. Maybe this was one of the snags.

Maybe we need to improve the sample data that's in there?

Any suggestions for what we need to do to upgrade this as a demo would be welcome :)

kinlane commented 5 years ago

I'm going through all the demos now that I'm getting caught up. I'll be stabilizing the demo and miami as part of the work. And looking at the dev portals too.