Ranter
Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
Comments
-
Documentation is mostly not needed.
Most things we built are CRUD applications.
It is so boiler plate that even OpenApi can often be auto-created from the boilerplate with some annotations.
How does it work?
Controller receives a pre-validated DTO with a user object connected. Performs any advanced access checks, then calls some backend service that either saves it to the database or loads it from the database.
If the data is not correct? Well, 422, bitch. That's it.
Sure, there are cooler projects. And those benefit of documentation. But if you need documentation for the Laravel, Bootstrap, Axium, Play!, Nest or what the fuck else backend that does just exactly what it was designed to do and looks 99% like the examples on the "Getting Started" section of their website... Nope.. Then it is on you. -
OpenAPI / Swagger should be sufficient documentation for developers. That is developers working on the same project / same field.
If I'm working on an e-shop and inherit a post office project, most data structure fields won't make sense. And temporal coupling cases will be a mystery. So yes, in that case, BE API docs are necessary. -
Most backend devs are too arrogant to routinely consider anyone else’s perspective because they are bottoms and are used to getting railed
A backend dev just told A frontend dev via slack that documentation is not necessary for backend and provided a backend PR for backend feature the frontend dev needed, he said the implementation is easy, am I dreaming or what the he'll is going on here 😩😩
Guess what ? the entire backend has no documentation 🤣🤣🤣🤣, just search the PRs you frontend freaks 😜, I feel sorry for my friend 🤣🤣🤣
rant