44 lines
1.0 KiB
Markdown
44 lines
1.0 KiB
Markdown
# File Manager API Server
|
|
|
|
## Kuvaus
|
|
ApiServer tarjoaa turvallisen rajapinnan tiedostonhallinnan toimintoihin. Kaikki kutsut vaativat API-avaimen.
|
|
|
|
## Käynnistys
|
|
```bash
|
|
cd ApiServer
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
## Ympäristömuuttujat (.env)
|
|
- `PORT`: Palvelimen portti (oletus: 3001)
|
|
- `API_KEY`: API-avain, jota vaaditaan kaikissa kutsuissa
|
|
- `NODE_ENV`: Ympäristö (development/production)
|
|
|
|
## Autentikointi
|
|
Kaikki API-kutsut vaativat Authorization-headerin:
|
|
```
|
|
Authorization: Bearer YOUR_API_KEY
|
|
```
|
|
|
|
## Endpointit
|
|
|
|
### GET /api/v1/health
|
|
Terveystarkistus - palauttaa palvelimen tilan.
|
|
|
|
### GET /api/v1/server-info
|
|
Palauttaa palvelimen tiedot ja ominaisuudet.
|
|
|
|
### GET /api/v1/servers
|
|
Palauttaa listan hallinnoiduista palvelimista.
|
|
|
|
### GET /api/v1/servers/:id
|
|
Palauttaa tietyn palvelimen tiedot.
|
|
|
|
### POST /api/v1/servers/:id/test
|
|
Testaa yhteyden tiettyyn palvelimeen.
|
|
|
|
## Tietoturva
|
|
- Kaikki kutsut vaativat kelvollisen API-avaimen
|
|
- Virheelliset API-avaimet palauttavat 401 Unauthorized
|
|
- Kaikki kutsut lokitetaan |