mirror of
https://github.com/tiqi-group/pydase.git
synced 2025-06-09 15:00:40 +02:00
baad1268e8
- using material theme instead of readthedocs
- introducing "Interacting with pydase Services" guide
- restful api docs
- auto-generated frontend
- pydase.Client
15 lines
576 B
Markdown
15 lines
576 B
Markdown
# RESTful API
|
|
|
|
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.
|
|
|
|
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"/>
|