swagccg 0.3.4

Swagger Client Code Generator. Using Python. For Python.

swagccg-py2py

Swagger Client Code Generator. Using Python. For Python

---

Summary

Immediately testing new resources is important if resources are going to be co-dependent. While the tools at SwaggerHub are mind blowing they may represent an overkill for not yet production code. Typing a single query can be done in any browser or with tools like curl. This tool aims to place itself between those two categories.

On top of that, I would expect a programming language to be able to create its own tools. While Java is a mature and well established language, it might not be within the proficiency portfolio of each and everyone - not to mention the author.

Get the Code

🚨 not yet

pip install swagccg-py2py

or clone it into your development environment

git clone https://github.com/erkandem/swagccg-py2py.git

or download the zip

https://github.com/erkandem/swagccg-py2py/archive/master.zip

Getting started

The assumption here ist that you already have a swagger.json file.

The creation of a client comes down to:

python swagccg

If the config.json is not in your working directory you would have to add its location to the call:

python -m swagccg -c /location/of/your/config.json

the configuration file

config.json consists of two distinct parts. First, we would like to tell the script:

• where we keep a swagger definition
• where we would like the client module to be created
• what name we would like the client class to have

Since this is rather a development tool we would like to switch between target hosts with little afford (i.e. environment variable). Therefore, we will offer it two targets which are later used to assamble resource URLs.

We'll set a local (i.e. development) and remote (i.e. deployed) set of:

• port
• base url (i.e IPv4, host, domain_name.tld, subdomain.domain_name.tld)
• scheme (http or https)

{
  "swagger_path": "/home/abuser/apiclient/swagger.json",
  "target_path": "/home/abuser/apiclient/auto_client.py",
  "class_name": "Myclient",


  "api_port_local": "5000",
  "api_url_base_local": "127.0.0.1",
  "api_protocol_local": "http",

  "api_port_remote": "80",
  "api_url_base_remote": "deployed.com",
  "api_protocol_remote": "https"
}

Client Creation

python -m swagccg --c location/of/your/config.json

Client Usage

Ultimately, the usage of the client depends on your requirements. Nonetheless, the README would be incomplete without some usage examples:

from auto_client import MyApiClient # default names - set them in confi.json
from settings import credential_dict # if needed

client_instance = MyApiClient('remote')  # or 'local' 
client_instance.login_with_api(credential_dict) 
data = client_instance.get_something_r() 

or

import os
from pathlib import Path
from dotenv import load_dotenv
from auto_client import MyApiClient
#%%
env_path = Path('.') / '.env'
load_dotenv(dotenv_path=env_path)
client_instance = MyApiClient('remote')

#%% login of course depends on the server
client_instance.login_with_api({
    'username': os.getenv('API_USERNAME'),
    'password': os.getenv('API_PASSWORD')
})
param_dict = dict(name='value')
data = client_instance.get_something_r(fields_data=param_dict)

gotchas

• authorization is highly custom
• most of the swagger details are not parsed
• models and mapping is omitted (marshmallow)
• little to none HTTP status codes parsing
• assumes knowledge on HTTP HEADER, BODY, METHOD
• pass pass_through=True as parameter to receive the response object untouched

recommended reading

Mark Masse, REST API Design Rulebook - Designing Consistent RESTful Web Service Interfaces

Petstore - API

OpenAPI Specififcation

Contact

Email [e-mail]

Issues: github.com/erkandem/swagccg-py2py/issues

Source: github.com/erkandem/swagccg-py2py

Documentation: github.com/erkandem/swagccg-py2py/README.md

License

My project is licensed under terms of MIT. For details please see the LICENSE

The examples and tests depend on the petstore. The attached petstore swagger by smartbear / OpenAPI Initiative is licensed with MIT and is part of the Apache 2.0 licensed repo.

Click Bait

Visitors who were interested in this repo also took a look at:

swagccg-m2m - MatLab to MatLab Client Code Generation

Because every programming language should be able to create its own tools.