ITQC/pydase
24
0
Fork 0
mirror of https://github.com/tiqi-group/pydase.git synced 2025-06-11 07:47:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: updates documentation

Browse Source
This commit is contained in:
Mose Müller
2024-07-30 10:36:40 +02:00
parent bd6220cb9e
commit 9e852c17ac
2 changed files with 32 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/user-guide/interaction/RESTful API.md
View File

@ -2,13 +2,21 @@
The `pydase` RESTful API allows for standard HTTP-based interactions and provides access to various functionalities through specific routes. This is particularly useful for integrating `pydase` services with other applications or for scripting and automation.
For example, you can get a value like this:
```python
import json
import requests
response = requests.get(
"http://<hostname>:<port>/api/v1/get_value?access_path=<full_access_path>"
)
serialized_value = json.loads(response.text)
```
To help developers understand and utilize the API, we provide an OpenAPI specification. This specification describes the available endpoints and corresponding request/response formats.
## OpenAPI Specification
**Base URL**:
```
http://<hostname>:<port>/api/
```
<swagger-ui src="./openapi.yaml"/>