diff --git a/API.md b/API.md index 0316e76..0a2ae37 100644 --- a/API.md +++ b/API.md @@ -1,6 +1,15 @@ # API Documentation +## Introduction +This documentation explains the API for the [ENcarteS](https://encartes.aliens-lyon.fr) project for [AliENS](https://aliens-lyon.fr). +The backend is based on Symfony 8.2, check the README.md to install it. +To make a request to the API you should request("[https://encartes.aliens-lyon.fr/api/map/FUNCTION/ARGUMENT1/ARGUMENT2...](https://encartes.aliens-lyon.fr/api/)") +(for local use, replace https://encartes.aliens-lyon.fr/ by http://127.0.0.1:8000/) +It has been authored by Basile Leretaille & Samy Avrillon +Other participants for this project are Adrien Vannson & Gabriel Dehame & Maxime Just & Tristan Klein + +## Functions ### /api/map/get_floor/ID/REPRESENTATION > Return a list of place composing floor _ID_ > _REPRESENTATION_ is the representation' type to consider for every places in {'Cylinder', 'PolySurface'}. The default is 'Cylinder'