:feat: Added headers handling to generated code if they are required through the API

Author: MarcoMuellner

poetry.lock

@@ -34,6 +34,7 @@ def write_code(path: Path, content) -> None:
                 formatted_contend = black.format_file_contents(
                     content, fast=False, mode=black.FileMode(line_length=120)
                 )
+
             except NothingChanged:
                 formatted_contend = content
             formatted_contend = isort.code(formatted_contend, line_length=120)
@@ -142,5 +143,7 @@ def generate_data(
     """
     data = get_open_api(source)
     click.echo(f"Generating data from {source}")
+
     result = generator(data, library_config_dict[library], env_token_name, use_orjson)
+
     write_data(result, output)

src/openapi_python_generator/generate_data.py

@@ -20,5 +20,5 @@ def generate_api_config(
         content=JINJA_ENV.get_template(API_CONFIG_TEMPLATE).render(
             env_token_name=env_token_name, **data.dict()
         ),
-        base_url=data.servers[0].url,
+        base_url=data.servers[0].url if len(data.servers) > 0 else "NO SERVER",
     )

src/openapi_python_generator/language_converters/python/api_config_generator.py

@@ -1,5 +1,5 @@
 import re
-from typing import Dict
+from typing import Dict, Literal
 from typing import List
 from typing import Tuple
 from typing import Union
@@ -158,19 +158,24 @@ def generate_operation_id(operation: Operation, http_op: str) -> str:
         raise Exception(f"OperationId is not defined for {http_op}")  # pragma: no cover
 
 
-def generate_query_params(operation: Operation) -> List[str]:
+def _generate_params(operation: Operation, param_in : Literal["query", "header"] = "query"):
     if operation.parameters is None:
         return []
 
     params = []
     for param in operation.parameters:
-        if isinstance(param, Parameter) and param.param_in == "query":
+        if isinstance(param, Parameter) and param.param_in == param_in:
             param_name_cleaned = param.name.replace("-", "_")
 
             params.append(f"'{param.name}' : {param_name_cleaned}")
 
     return params
 
+def generate_query_params(operation: Operation) -> List[str]:
+    return _generate_params(operation, "query")
+
+def generate_header_params(operation: Operation) -> List[str]:
+    return _generate_params(operation, "header")
 
 def generate_return_type(operation: Operation) -> OpReturnType:
     if operation.responses is None:
@@ -257,13 +262,15 @@ def generate_service_operation(
         params = generate_params(op)
         operation_id = generate_operation_id(op, http_operation)
         query_params = generate_query_params(op)
+        header_params = generate_header_params(op)
         return_type = generate_return_type(op)
         body_param = generate_body_param(op)
 
         so = ServiceOperation(
             params=params,
             operation_id=operation_id,
             query_params=query_params,
+            header_params=header_params,
             return_type=return_type,
             operation=op,
             pathItem=path,

src/openapi_python_generator/language_converters/python/service_generator.py

@@ -5,7 +5,9 @@ async def {{ operation_id }}({{ params }}) -> {% if return_type.type is none or
     'Content-Type': 'application/json',
     'Accept': 'application/json',
     'Authorization': f'Bearer { APIConfig.get_access_token() }',
+    {{ header_params | join(',\n') | safe }}
     }
+
     query_params : Dict[str,Any] = {
     {% if query_params|length > 0 %}
         {{ query_params | join(',\n') | safe }}

src/openapi_python_generator/language_converters/python/templates/aiohttp.jinja2

@@ -3,7 +3,8 @@
 from typing import Optional, Union
 
 class APIConfig():
-    base_path: str = '{{ servers[0].url }}'
+    base_path: str = {% if servers|length > 0 %} '{{ servers[0].url }}' {% else %} 'NO SERVER' {% endif %}
+
     verify: Union[bool, str] = True
 {% if env_token_name is none %}
     _access_token : Optional[str] = None

src/openapi_python_generator/language_converters/python/templates/apiconfig.jinja2

@@ -5,6 +5,7 @@
         'Content-Type': 'application/json',
         'Accept': 'application/json',
         'Authorization': f'Bearer { APIConfig.get_access_token() }',
+        {{ header_params | join(',\n') | safe }}
     }
     query_params : Dict[str,Any] = {
     {% if query_params|length > 0 %}

src/openapi_python_generator/language_converters/python/templates/httpx.jinja2

@@ -5,7 +5,8 @@ def {{ operation_id }}({{ params }}) -> {% if return_type.type is none or return
         'Content-Type': 'application/json',
         'Accept': 'application/json',
         'Authorization': f'Bearer { APIConfig.get_access_token() }',
-    }
+        {{ header_params | join(',\n') | safe }}
+        }
     query_params : Dict[str,Any]  = {
     {% if query_params|length > 0 %}
         {{ query_params | join(',\n') | safe }}

src/openapi_python_generator/language_converters/python/templates/requests.jinja2

@@ -32,6 +32,7 @@ class ServiceOperation(BaseModel):
     params: str
     operation_id: str
     query_params: List[str]
+    header_params: List[str]
     return_type: OpReturnType
     operation: Operation
     pathItem: PathItem

src/openapi_python_generator/models.py

@@ -0,0 +1,27 @@
+import pytest
+from click.testing import CliRunner
+
+from openapi_python_generator.__main__ import main
+from openapi_python_generator.common import HTTPLibrary
+from openapi_python_generator.generate_data import generate_data
+from tests.conftest import test_data_folder
+from tests.conftest import test_result_path
+
+
+@pytest.fixture
+def runner() -> CliRunner:
+    """Fixture for invoking command-line interfaces."""
+    return CliRunner()
+
+@pytest.mark.parametrize(
+    "library",
+    [HTTPLibrary.httpx, HTTPLibrary.aiohttp, HTTPLibrary.requests],
+)
+def test_issue_11(runner: CliRunner, model_data_with_cleanup, library) -> None:
+    """
+    https://github.com/MarcoMuellner/openapi-python-generator/issues/7
+    """
+    assert generate_data(test_data_folder / "issue_17.json",
+                  test_result_path,
+                  library) is None
+