refactor: Module Structure #21
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Your Render PR Server URL is https://express-typescript-2024-pr-21.onrender.com. Follow its progress at https://dashboard.render.com/web/srv-cmlb172cn0vc73c6h61g. |
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this refactor, we simplified the module structure by integrating the Controller functionality directly into the Router files. This decision was driven by the observation that using separate Controller classes required initializing these classes and managing multiple dependencies for initialization. To streamline this process and enhance the maintainability of our code, we transitioned to a more functional approach.
Key Changes:
Controller and Router Integration: Controller logic is now embedded within the Router files. This reduces the overhead of managing separate files and class initializations, making it easier to add new functions and routes.
Functional Approach: Shifted from class-based Controllers to a functional style in Router files. This makes the code more straightforward and reduces the complexity involved in setting up new modules.
To Be Decided (TBD):
API Documentation Generator: We are considering the implementation of an API documentation generator. This tool would automatically generate a user-friendly UI to interact with our API endpoints, enhancing the developer experience and aiding in API testing and integration.