Good workflow ?

[slamer59]

Hello,
I wonder how to have a nice workflow.

Constructing this application is an iterrative process so how do you organize yourself to not override previously implemented endpoints ?
I ses no problem to override models but endpoints ?

Two options :

• commit your change to git and override the same folder output. use the git diff to reintegrate your work
• generate to another folder and use another dif tools ?

Regards

[akruis]

I use the following approach:

• In the openapi definition I use operationId values of the form MODULE_NAME '.' FUNCTION_NAME, for instance myapi.info.

• Then I use a custom template main.jinja2. Here is a simplified version of the code

    from __future__ import annotations
    import myapi   #  the name of the module must match the leading part of the OpenAPI operationId
    from fastapi import FastAPI, Depends
    
    {{imports}}
    
    app = FastAPI(
        {% if info %}
        {% for key,value in info.items() %}
        {% set info_value= value.__repr__() %}
        {{ key }} = {{info_value}},
        {% endfor %}
        {% endif %}
        )
    
    {% for operation in operations %}
    @app.{{operation.type}}('{{operation.path}}', response_model={{operation.response}}
        {% if operation.additional_responses %}
            , responses={
                {% for status_code, models in operation.additional_responses.items() %}
                    '{{ status_code }}': {
                    {% for key, model in models.items() %}
                        '{{ key }}': {{ model }}{% if not loop.last %},{% endif %}
                    {% endfor %}
                    }{% if not loop.last %},{% endif %}
                {% endfor %}
            }
        {% endif %}
        {% if operation.tags %}
        , tags={{operation.tags}}
        {% endif %}
        {% if operation.operationId %}
        , operation_id='{{operation.operationId}}'
        {% endif %}
        )
    async def {{operation.function_name}}({{operation.snake_case_arguments}}
    ) -> {{operation.return_type}}:
        {%- if operation.summary %}
        """
        {{ operation.summary }}
        """
        {%- endif %}
        return await {{operation.operationId}}(**locals())
    {% endfor %}
  

• In the module myapi I define the implementation of the operations. For instance

  import models

  async def info(some_argument: models.SomeArgType):
  ...

This way I do not need to modify the generated main.py file.

[slamer59]

Nice. It is something really close I do anyway for connection to an ORM.