PRM_Software_AG
/
api-documentation
12
1
Fork 0
Code Issues 10 Pull Requests Activity

First commit of a rough draft and the old doc.

This commit is contained in:
Nico Kroll 2024-04-12 15:09:15 +02:00
parent 7af11e6066
commit a377a8ecbb
3 changed files with 9704 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,5 +1,20 @@
# API-documentation of TyrePro
# API documentation of TyrePro
Public REST-API of TyrePro and it's services.
## How it's written?
Please feel free to contact if you find a bug or you need more data ;) .
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!

4837
src/common.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

4849
src/old_docu.yaml Normal file
View File

File diff suppressed because it is too large Load Diff