This is part of the Semicolon&Sons Code Diary - consisting of lessons learned on the job. You're in the workflows category.
Last Updated: 2024-11-23
In the Project S Laravel backend, I included documentation about the API in the routes and ALSO in the README. This was superfluous and led to too much maintenance when one thing changed.
Do not document APIs in two places. There should be a centralized location. The routes file would have been fine. The API docs should have then been generated from the code.