In developing the API for Neighbourhood we wanted to ensure that we adhere to REST1 principles.

Leveraging these principles, we designed an API that implemented a logical structure. Through standardized endpoints we achieved a consistent and intuitive experience for users across different devices and platforms.

Our API facilitated neighbourhood creation, membership management, and interaction, following RESTful conventions for resource manipulation. By defining clear and predictable endpoints for neighbourhood CRUD operations, users can seamlessly create, join, or leave neighborhoods, while neighbourhood admins can approve membership requests and update their neighbourhoods’ information with ease.

Our users also have the ability to create and respond to their neighbours’ requests. Both entities (requests and responses) were given their own routers with a multitude of available endpoints for streamlined interaction and collaboration.

By following the established patterns for resource management, interaction, and manipulation, we ensured a seamless and intuitive user experience.

API Map

  1. https://restfulapi.net ↩