Learn More
Resend Email
20
zshh
7y

Just released version 1 of my first API! For this project I did everything the way I wanted to, no shortcuts! I documented the shit out of every endpoint and parameter. Everything is throughly tested and it’s dockerized. I also have metrics for each endpoint (with Grafana in the frontend, which I love) as well as alerts in case it would go down for some reason.

I prepared all of this before deploying it out into the wild and damn, it feels so good. Probably no one will use it but I don’t care. It’s one of those projects where you have to force yourself to go to bed at 2 AM.

Just some thoughts. Don’t really have any techie friends so figured maybe someone here recognizes that feeling. Also I wrote it in Python, such a pleasant language.

rant

🐍

💻

api

fuck sleep

documentation
Favorite
Ranter
Comments
  • 2
    7y
    That's awesome congrats! What's the API for?
  • 1
    7y
    Commenting for later in case he answers
  • 2
    7y
    What's the api for? Someone might find it useful.
  • 1
    7y
    Sounds great! Haha congrats buddy. What's this API for?
  • 1
    7y
    Thanks, guys!

    It’s essentially a wrapper for a large gaming site. It parses the HTML and returns JSON. It has 5 endpoints which all of them have 1-3 parameters.

    @ryanmhoffman @SpencerBeige
    @esaysimyan
    @Veox
  • 0
    7y
    By the way, does anyone know where to find good documentation for an API? I’m thinking of extending mine and I want to have some inspiration.
  • 1
    7y
    @zshh i love the highcharts api dokcumentation xD
  • 1
    7y
    @zshh

    Not sure what documentation you would like to have

    I always liked to autogenerate my API documentation directly from my code with swagger and then having my service hosting its own documentation

    If you search for API design documentation

    I would recommend domain driven design there are some books and help online in the direction of desiging rest apis
  • 1
    7y
    Everyone, someone else used the API yesterday! Someone else than me. Such a cool feeling.
  • 1
    7y
    @zshh nice! It's always exciting when something you made is useful for others.
  • 0
    6y
    Update: I had to shut down this project as it was infringing on copyrighted content :( I had no idea but then I got threatened to be sued so I had to shut everything down. Oh well, I learned a lot.
Related Rants
devRant © 2021 Hexical Labs LLC
Privacy Policy  |  Terms of Service
Add Comment