An API should state what it will do and do what it has said. You should not have to read the code behind the API to call it. There should not be a “tribal knowledge” on the behavior of the API. It should not have unintended consequences not described in the API.
I've fallen in love with FastAPI recently, and one of the reasons I enjoy using it is because it automatically generates Swagger documentation from the function declarations. There's no need to mess with additional configuration or documentation--the functions themselves are the source of truth.
I've fallen in love with FastAPI recently, and one of the reasons I enjoy using it is because it automatically generates Swagger documentation from the function declarations. There's no need to mess with additional configuration or documentation--the functions themselves are the source of truth.