@team-supercharge/oasg 13.2.0-feature-python-fastapi-60ed9d6b.0 → 13.2.0-feature-python-fastapi-0a55030b.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "13.2.0-feature-python-fastapi-60ed9d6b.0",
+  "version": "13.2.0-feature-python-fastapi-0a55030b.0",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",

package/targets/python-fastapi/templates/README.mustache

@@ -0,0 +1,43 @@
+# OpenAPI generated FastAPI server
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: {{appVersion}}
+{{^hideGenerationTimestamp}}
+- Build date: {{generatedDate}}
+{{/hideGenerationTimestamp}}
+- Build package: {{generatorClass}}
+
+## Requirements.
+
+Python >= {{{generatorLanguageVersion}}}
+
+## Installation & Usage
+
+To run the server, please execute the following from the root directory:
+
+```bash
+pip3 install -r requirements.txt
+pip3 install uvicorn
+uvicorn --app-dir src {{packageName}}.main:app --host 0.0.0.0 --port {{serverPort}}
+```
+
+and open your browser at `http://localhost:{{serverPort}}/docs/` to see the docs.
+
+## Running with Docker
+
+To run the server on a Docker container, please execute the following from the root directory:
+
+```bash
+docker-compose up --build
+```
+
+## Tests
+
+To run the tests:
+
+```bash
+pip3 install pytest
+pip3 install httpx
+PYTHONPATH=src pytest tests
+```

package/targets/python-fastapi/templates/api.mustache

@@ -0,0 +1,62 @@
+# coding: utf-8
+
+from typing import Dict, List  # noqa: F401
+import importlib
+import pkgutil
+
+from {{apiPackage}}.{{classFilename}}_{{baseSuffix}} import Base{{classname}}
+
+from fastapi import (  # noqa: F401
+    APIRouter,
+    Body,
+    Cookie,
+    Depends,
+    Form,
+    Header,
+    Path,
+    Query,
+    Request,
+    Response,
+    Security,
+    status,
+)
+
+from {{modelPackage}}.extra_models import TokenModel  # noqa: F401
+{{#imports}}
+{{import}}
+{{/imports}}
+
+router = APIRouter()
+
+{{#operations}}
+{{#operation}}
+@router.{{#lambda.lowercase}}{{httpMethod}}{{/lambda.lowercase}}(
+    "{{path}}",
+    responses={
+        {{#responses}}
+        {{code}}: {{=<% %>=}}{<%#dataType%>"model": <%dataType%>, "description": "<%message%>"<%/dataType%><%^dataType%>"description": "<%message%>"<%/dataType%>}<%={{ }}=%>,
+        {{/responses}}
+    },
+    tags=[{{#tags}}"{{name}}"{{^-last}},{{/-last}}{{/tags}}],
+    {{#summary}}
+    summary="{{.}}",
+    {{/summary}}
+    {{#description}}
+    description = "{{.}}",
+    {{/description}}
+    response_model_by_alias=True,
+)
+async def {{operationId}}(
+    request: Request,
+    {{#allParams}}
+    {{>endpoint_argument_definition}},
+    {{/allParams}}
+) -> Response: # -> {{returnType}}{{^returnType}}None{{/returnType}}
+    {{#notes}}"""{{.}}"""
+    return await Base{{classname}}.subclasses[0]().{{operationId}}(request{{#allParams}}, {{>impl_argument}}{{/allParams}}){{/notes}}{{^notes}}...{{/notes}}
+{{^-last}}
+
+
+{{/-last}}
+{{/operation}}
+{{/operations}}

package/targets/python-fastapi/templates/base_api.mustache

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+from typing import ClassVar, Dict, List, Tuple  # noqa: F401
+from fastapi import Request, Response
+
+{{#imports}}
+{{import}}
+{{/imports}}
+
+class Base{{classname}}:
+    subclasses: ClassVar[Tuple] = ()
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        Base{{classname}}.subclasses = Base{{classname}}.subclasses + (cls,)
+
+{{#operations}}
+{{#operation}}
+    async def {{operationId}}(
+        self,
+        request: Request,
+        {{#allParams}}
+        {{>impl_argument_definition}},
+        {{/allParams}}
+    ) -> Response: # -> {{returnType}}{{^returnType}}None{{/returnType}}
+        {{#notes}}"""{{.}}"""
+        ...{{/notes}}{{^notes}}...{{/notes}}
+{{^-last}}
+
+{{/-last}}
+{{/operation}}
+{{/operations}}

package/targets/python-fastapi/templates/endpoint_argument_definition.mustache

@@ -0,0 +1 @@
+{{#isPathParam}}{{baseName}}{{/isPathParam}}{{^isPathParam}}{{paramName}}{{/isPathParam}}: {{>param_type}} = {{#isPathParam}}Path{{/isPathParam}}{{#isHeaderParam}}Header{{/isHeaderParam}}{{#isFormParam}}Form{{/isFormParam}}{{#isQueryParam}}Query{{/isQueryParam}}{{#isCookieParam}}Cookie{{/isCookieParam}}{{#isBodyParam}}Body{{/isBodyParam}}({{&defaultValue}}{{^defaultValue}}{{#isPathParam}}...{{/isPathParam}}{{^isPathParam}}None{{/isPathParam}}{{/defaultValue}}, description="{{description}}"{{#isQueryParam}}, alias="{{baseName}}"{{/isQueryParam}}{{#isLong}}{{#minimum}}, ge={{.}}{{/minimum}}{{#maximum}}, le={{.}}{{/maximum}}{{/isLong}}{{#isInteger}}{{#minimum}}, ge={{.}}{{/minimum}}{{#maximum}}, le={{.}}{{/maximum}}{{/isInteger}}{{#pattern}}, regex=r"{{.}}"{{/pattern}}{{#minLength}}, min_length={{.}}{{/minLength}}{{#maxLength}}, max_length={{.}}{{/maxLength}})

package/targets/python-fastapi/templates/requirements.mustache

@@ -0,0 +1,2 @@
+fastapi==0.109.2
+pydantic==2.6