21 lines
1.0 KiB
Markdown
21 lines
1.0 KiB
Markdown
# API documentation of TyrePro
|
|
|
|
## How it's written?
|
|
|
|
The documentations follow the OpenAPI 3.0.0 specifications. You can read the yaml-files manually or use any editor like [Swagger](https://editor.swagger.io/) or similar.
|
|
|
|
## How to get started?
|
|
|
|
1. Explore the endpoints of the common.yaml! There you find some general points and the ways of how to create a session.
|
|
2. Explore the other yaml files, check which permissions (sessions) you need and let's go!
|
|
|
|
## Is the API stable?
|
|
|
|
*Time is change. Nothing is stable.* Even when it may sound rough, but it's the truth. During development on a specific part, there will be a lot of changes. Someone requests something new (or changed) and there will be changes. We need to update some points to fullfil further requirements in our application - other changes coming.
|
|
|
|
That is the reason why we put this API documentation in a public git: that you're able to track what changed.
|
|
|
|
## I've more questions!
|
|
|
|
Don't hesitate to visit our [homepage](https://prm-ag.de) to contact us!
|