slococo-uni
/
getendpoints
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Santiago Lo Coco 2024-10-25 22:22:52 +02:00
parent 4f0c990601
commit 3268e544cc
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,6 +1,6 @@
# GetEndpoints
This REST API is for managing WebRTC endpoint streams. It is designed for a Unity app running on the HoloLens, where typing and changing settings can be slow and frustrating. Instead of hardcoding endpoints and having to redeploy the app whenever changes are needed, this API provides a single source of truth (SSOT). You can easily update the endpoints whenever you want, making it simple to manage without hassle.
This REST API and responsive web application manage WebRTC endpoint streams. It is designed for a Unity app running on the HoloLens, where typing and changing settings can be slow and frustrating. Instead of hardcoding endpoints and having to redeploy the app whenever changes are needed, this setup provides a single source of truth (SSOT). You can easily update the endpoints whenever you want, making it simple to manage without hassle.
## Prerequisites
@ -31,15 +31,21 @@ This REST API is for managing WebRTC endpoint streams. It is designed for a Unit
### cURL examples
- curl http://windows.local:5000/api/endpoints
- curl http://windows.local:5000/api/endpoints/1
- curl -X PUT http://windows.local:5000/api/endpoints/1 -H "Content-Type: application/json" -d '{"url": "http://windows.local:8500/mystream/"}'
```
curl http://windows.local:5000/api/endpoints
curl http://windows.local:5000/api/endpoints/1
curl -X PUT http://windows.local:5000/api/endpoints/1 -H "Content-Type: application/json" -d '{"url": "http://windows.local:8500/mystream/"}'
```
### Invoke-WebRequest examples
- Invoke-WebRequest -Uri http://windows.local:5000/api/endpoints
- Invoke-WebRequest -Uri http://windows.local:5000/api/endpoints/1
- Invoke-WebRequest -Uri http://windows.local:5000/api/endpoints/1 -Method PUT -Headers @{"Content-Type"="application/json"} -Body '{"url": "http://windows.local:8500/mystream/"}'
```
Invoke-WebRequest -Uri http://windows.local:5000/api/endpoints
Invoke-WebRequest -Uri http://windows.local:5000/api/endpoints/1
Invoke-WebRequest -Uri http://windows.local:5000/api/endpoints/1 -Method PUT -Headers @{"Content-Type"="application/json"} -Body '{"url": "http://windows.local:8500/mystream/"}'
```
## API host