Mysaa/Encartes-backend
1
0
Fork 0
mirror of https://gitlab.aliens-lyon.fr/encartes/backend.git synced 2026-03-17 14:41:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add introduction to API Documentation

Browse Source
This commit is contained in:
Kouril42 2023-02-14 13:46:16 +01:00
parent 7e0afd10ea
commit f8ac8df38b
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
API.md
View File

@ -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'