A First Look at Semaphore’s New API Specification Semantic
Blog post from Semaphore
Semaphore is in the process of redesigning its public API, focusing on establishing clear guidelines and semantics for URI path elements to improve usability. The design approach aims to balance between directly exposing database elements and implementing a layer of abstraction, ultimately deciding to RESTify UML class diagrams by exposing only objects as resources, while managing relationships implicitly. The API's URI path structure is limited to four elements, offering specific semantics for each format, and operations are streamlined to basic CRUD (Create, Read, Update, Delete) functions, conducted on objects and their relationships. The design choice to manage relationships without requiring users to handle identifiers simplifies API usage, and although the redesign is still in the preview stage, it promises to enhance user experience by providing a more descriptive and intuitive interface.