@@ -20,8 +20,8 @@ First, you have to generate a Python client, from [Swagger Editor](https://edito
2020For example:
2121
2222``` sh
23- sudo docker run --rm -v ${PWD} :/local swaggerapi/swagger-codegen-cli:2.4.7 generate \
24- -i http ://petstore.swagger.io/v2/swagger.json \
23+ sudo docker run --rm -v ${PWD} :/local swaggerapi/swagger-codegen-cli:latest generate \
24+ -i https ://petstore.swagger.io/v2/swagger.json \
2525 -l python \
2626 -o /local/out/python
2727```
@@ -198,17 +198,36 @@ Example of usages, and return values:
198198
199199``` sh
200200$ ./open-api-cli.py api PetApi get_pet_by_id --pet_id 1
201- {' category' : {' id' : 1, ' name' : ' string' },
202- ' id' : 1,
203- ' name' : ' cat' ,
204- ' photo_urls' : [' string' ],
205- ' status' : ' available' ,
206- ' tags' : [{' id' : 1, ' name' : ' string' }]}
201+ {" id" :1," category" :{" id" :1," name" :" String" }," name" :" String" ," photoUrls" :[" string" ]," tags" :[{" id" :10," name" :" String" }]," status" :" available" }
207202```
208203
209204``` sh
210205$ ./open-api-cli.py api StoreApi get_inventory
211- {' sold' : 193, ' ksks' : 1, ' c' : 1, ' string' : 1, ' Operated' : 4, ' unavailable' : 2, ' velit ' : 1, ' Nonavailable' : 1, ' pending' : 175, ' Not-Operated' : 10, ' available' : 345, ' PENDING' : 1, ' Not Found' : 1, ' 767778' : 1, ' tempor labore n' : 1, ' AVAILABLE' : 1, ' swimming' : 1, ' SOLD' : 2, ' amet' : 1, ' {{petStatus}}' : 1, ' Pending' : 2, ' qwe' : 1, ' Reserved' : 1}
206+ {" sold" :5," string" :289," alive" :1," Nonavailable" :1," pending" :14," available" :657," hehe" :1," adopted" :1}
207+ ```
208+
209+ You can pipe the result to ` jq ` :
210+
211+ ``` shell
212+ $ ./open-api-cli.py api PetApi find_pets_by_status --status ' ["available"]' | jq " .[0]"
213+ {
214+ " id" : 9222968140498485000,
215+ " category" : {
216+ " id" : 0,
217+ " name" : " string"
218+ },
219+ " name" : " fish" ,
220+ " photoUrls" : [
221+ " string"
222+ ],
223+ " tags" : [
224+ {
225+ " id" : 0,
226+ " name" : " string"
227+ }
228+ ],
229+ " status" : " available"
230+ }
212231```
213232
214233## TODO
@@ -222,7 +241,7 @@ $ ./open-api-cli.py api StoreApi get_inventory
222241- ~~ add help for argument format (API Models). Add 'type' subparser?~~
223242- ~~ add the possibility to change the host url~~
224243- add unit tests
225- - ~~ Make ` --host ` mandatory, if not server url not set in swagger,~~
244+ - ~~ Make ` --host ` mandatory, if default server url is not set in swagger,~~
226245- ~~ add debug mode~~
227246- ~~ add proxy support~~
228247- ~~ add the possibility to disable SSL verification~~
0 commit comments