Joined devRant on 5/25/2019
Do all the things like ++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatarSign Up
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple APILearn More
This is the story of the API documentation.
Which btw I couldn't find on the producent's website anywhere. I had the pdf shared with me by a coworker.
I knew the api was fucked up the moment I looked at endpoint documentation.
GET params? WHERE, ORDERBY etc. Literally make a SQL select in a GET request.
Returned stuff? The whole thing. Not some DTO, you literally get everything you can get.
Eg if you get IP in your response, you get it in several formats: dotted form, as hex, and as int. In 3 different json fields.
Oh, and regarding IP - one would imagine you can use masks or prefixes for subnets, right? Nope. The only param you can use there is the subnet size. So you have to calculate the power of 2 every time you want to make a request.
That's from the endpoint documentation. But what about some general info on the API, before all that?
As I was looking for something, I decided to read that intro and general info about the API.
Okay, so there was a change log between API versions. "removed [endpoint which sounds like correct REST design], please use [this generic thing with SQL-like GETs]"... Several of them.
And there was also this sentence which said that the API is not restful, "it's REST-like". <facepalm>
If it was a bad attempt at REST API, I would let it go. But this sentence clearly showed they knew they did everything wrong. And the changelog showed they didn't stop there, they were actively making it worse.1
Sitting in an "Advanced Python" course (paid by my employer), I kicked something under my desk. I hope those guys know Python better than they know electrical security measures...5
I'm at work. It's been slow recently because our clients don't know what they want.
I just realised there's an itsy bitsy spider on my desk. Or more precisely, on my workstation.
A 2mm-or-so little spider, making a web between my screen and my laptop.
I'll feel bad when I'll be leaving and having to break its web...6
I just went to SO to browse questions and learn something or help someone...
THE FREAKING PRINTSCREEN OF IDE
INSTEAD OF COPYING THE CODE
And you know what's worse?
There was also a PHOTO of the output from the console.2