Designing API#

API Guidelines
status: draft
doc__api_guidelines
Generic Document

User friendly API design#

  • Each public API shall support the idioms of the programming language it is written in.

  • Each public API shall use core infrastructure of its programming language and accompanying standard libraries, whenever possible and meaningful.

Error handling#

  • (C++) exceptions shall not be used for error handling, as these will be directly leading to an abort and thus reducing availability of the S-CORE platform.

  • The best way to deal with errors is to try to resolve those component internally. If not possible the caller of the function shall be notified of the error.

  • For (error) returns there is a specific library to be used in S-CORE, it is the Score::Result library which is part of the Base Libraries feature.