Skip to content

Latest commit

 

History

History
13 lines (12 loc) · 1.23 KB

Backend-Development-Guidelines.md

File metadata and controls

13 lines (12 loc) · 1.23 KB

cBioPortal Development Guidelines

  1. Avoid introducing new functionality in the core module or creating new dependencies on the existing core module code.
  2. One exception to the previous guideline is that new data import functions should be added to the core module scripts package.
  3. Do not expand the business module.
  4. Place all new web API controllers in the web module.
  5. Make abstract data-driven web controllers part of the default/public interface (tag them with @PublicApi).
  6. Make Special purpose or visualization-driven web controllers part of the internal interface (tag them with @InternalApi).
  7. Do not include business logic in the web module handler functions. Limit processing to argument examination and service module method selection.
  8. Test new data-driven web controllers for proper behavior on a portal deployment which requires user authentication and authorities.
  9. Do not call persistence module functions directly from the web module. Create pass-through service layer functions instead.
  10. Locate database query code in the persistence modules, and follow existing patterns.
  11. Consider the tradeoffs between using database query constructs to accomplish business logic requirements versus writing service layer java code.