github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/python/python-experimental/api_doc_example.mustache (about) 1 ```python 2 from __future__ import print_function 3 import time 4 import {{{packageName}}} 5 from pprint import pprint 6 {{> python_doc_auth_partial}} 7 # Enter a context with an instance of the API client 8 {{#hasAuthMethods}} 9 with {{{packageName}}}.ApiClient(configuration) as api_client: 10 {{/hasAuthMethods}} 11 {{^hasAuthMethods}} 12 with {{{packageName}}}.ApiClient() as api_client: 13 {{/hasAuthMethods}} 14 # Create an instance of the API class 15 api_instance = {{{packageName}}}.{{{classname}}}(api_client) 16 {{#requiredParams}}{{^defaultValue}}{{paramName}} = {{{example}}} # {{{dataType}}} | {{{description}}} 17 {{/defaultValue}}{{/requiredParams}}{{#optionalParams}}{{paramName}} = {{{example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} if omitted the server will use the default value of {{{defaultValue}}}{{/defaultValue}} 18 {{/optionalParams}} 19 {{#requiredParams}} 20 {{#-last}} 21 22 # example passing only required values which don't have defaults set 23 try: 24 {{#summary}} # {{{.}}} 25 {{/summary}} {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}{{^-last}}, {{/-last}}{{/defaultValue}}{{/requiredParams}}){{#returnType}} 26 pprint(api_response){{/returnType}} 27 except {{{packageName}}}.ApiException as e: 28 print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) 29 {{/-last}} 30 {{/requiredParams}} 31 {{#optionalParams}} 32 {{#-last}} 33 34 # example passing only required values which don't have defaults set 35 # and optional values 36 try: 37 {{#summary}} # {{{.}}} 38 {{/summary}} {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}, {{/defaultValue}}{{/requiredParams}}{{#optionalParams}}{{paramName}}={{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}){{#returnType}} 39 pprint(api_response){{/returnType}} 40 except {{{packageName}}}.ApiException as e: 41 print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) 42 {{/-last}} 43 {{/optionalParams}} 44 {{^requiredParams}} 45 {{^optionalParams}} 46 47 # example, this endpoint has no required or optional parameters 48 try: 49 {{#summary}} # {{{.}}} 50 {{/summary}} {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}(){{#returnType}} 51 pprint(api_response){{/returnType}} 52 except {{{packageName}}}.ApiException as e: 53 print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) 54 {{/optionalParams}} 55 {{/requiredParams}} 56 ```