Autres/openkarotz-openapi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document usage of project

Browse Source
This commit is contained in:
Guilhem Bonnefille
2020-07-29 22:59:22 +02:00
parent 21180aa440
commit 494eb311b2
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1 +1,13 @@
An OpenAPI description of OpenKarotzAPI. An OpenAPI description of OpenKarotzAPI.
# Build
Use Makefile to:
1. download Swagger utility
2. generate documentation: `make doc`
3. generate python API client: `make python`
# Usage/Test
You can test the python API client with `test_python.py` example.