@team-supercharge/oasg 14.1.0-feature-csharp-functions-2e109dee.0 → 14.1.0-feature-python-fastapi-6dc5992a.0

package/README.md

@@ -683,6 +683,27 @@ TBD
 
 Publishing the PyPI packages is done with Twine. For authentication againts the PiPI repository you need to set the `TWINE_USERNAME` and `TWINE_PASSWORD` environment variables.
 
+
+#### `python-fastapi`
+
+```json
+{
+  "id": "server-python",
+  "type": "python-fastapi",
+  "source": "source-merged",
+  "packageName": "oasg_example",
+  "repositoryUrl": "https://gitlab.supercharge.io/api/v4/projects/1226/packages/pypi"
+}
+```
+
+|Parameter| Description| Required | Default |
+|-|-|-|-|
+| packageName | Package nem for the project (convention: snake_case) | Y | - |
+| repositoryUrl | URL of the PyPI repository | Y | - |
+
+Building the distribution package requires Flit.
+Publishing the PyPI packages is done with Twine. For authentication againts the PiPI repository you need to set the `TWINE_USERNAME` and `TWINE_PASSWORD` environment variables.
+
 #### `contract-testing`
 
 ```json

package/bin/exec.js

@@ -11,4 +11,15 @@ function exec(command, stdio) {
   }
 }
 
+function bash(command, stdio) {
+  try {
+    execSync(`bash -e -c "${command}"`, { stdio: stdio || 'inherit' });
+  }
+  catch (e) {
+    console.error(e.message);
+    exit(1);
+  }
+}
+
 exports.exec = exec;
+exports.bash = bash;

package/bin/oasg

@@ -15,6 +15,7 @@ const expressHttpProxy = require('express-http-proxy');
 const { exit } = require('process');
 
 const { exec } = require(`${__dirname}/exec.js`);
+const { bash } = require(`${__dirname}/exec.js`);
 const { merge } = require(`${__dirname}/merger.js`);
 const { applyOverrides } = require(`${__dirname}/overrider.js`);
 const { openApiTarget } = require(`${__dirname}/openapi-target.js`);
@@ -46,6 +47,7 @@ const DEFAULT_GENERATOR_MAPPING = {
   "nestjs":           { version: '7.0.1',   generator: 'typescript-angular' },
   "spring":           { version: '7.0.1',   generator: 'spring' },
   "spring-kotlin":    { version: '7.0.1',   generator: 'kotlin-spring' },
+  "python-fastapi":   { version: '7.0.1',   generator: 'python-fastapi' },
   "dotnet":           { version: '7.8.0',   generator: 'csharp-functions' },
   // misc targets
   "contract-testing": { version: '4.3.1',   generator: 'typescript-node' },
@@ -550,9 +552,9 @@ function fetchBinary(target) {
 
   // download binary
   console.log(`... downloading ${binary.url} ==> ${binaryPath}`);
-  exec(`mkdir -p ${BIN_FOLDER}`);
-  exec(`wget ${binary.url} -q -O ${binaryPath}`);
-  exec(`chmod +x ${binaryPath}`);
+  bash(`mkdir -p ${BIN_FOLDER}`);
+  bash(`wget ${binary.url} -q -O ${binaryPath}`);
+  bash(`chmod +x ${binaryPath}`);
   return binaryPath;
 }
 
@@ -583,9 +585,9 @@ function fetchFormatter(target) {
 
   // download binary
   console.log(`... downloading ${binary.url} ==> ${binaryPath}`);
-  exec(`mkdir -p ${BIN_FOLDER}`);
-  exec(`wget ${binary.url} -q -O ${binaryPath}`);
-  exec(`chmod +x ${binaryPath}`);
+  bash(`mkdir -p ${BIN_FOLDER}`);
+  bash(`wget ${binary.url} -q -O ${binaryPath}`);
+  bash(`chmod +x ${binaryPath}`);
   return binaryPath;
 }
 
@@ -596,12 +598,12 @@ function customizeTemplates(target) {
   const targetTemplateDir = `${__dirname}/../targets/${target.type}/templates`;
 
   if (fs.existsSync(templateDir)) {
-    exec(`rm -rf ${templateDir}`);
+  bash(`rm -rf ${templateDir}`);
   }
-  exec(`mkdir -p ${templateDir}`);
+  bash(`mkdir -p ${templateDir}`);
 
   if (fs.existsSync(targetTemplateDir)) {
-    exec(`cp -R ${targetTemplateDir}/* ${templateDir}`);
+    bash(`cp -R ${targetTemplateDir}/* ${templateDir}`);
   }
 
   if (target.templateDir) {
@@ -610,7 +612,7 @@ function customizeTemplates(target) {
       exit(1);
     }
 
-    exec(`cp -R ${target.templateDir}/* ${templateDir}`);
+    bash(`cp -R ${target.templateDir}/* ${templateDir}`);
   }
 
   return templateDir;

package/config.schema.yml

@@ -20,6 +20,7 @@ properties:
         - $ref: '#/targets/Android'
         - $ref: '#/targets/ios'
         - $ref: '#/targets/Python'
+        - $ref: '#/targets/PythonFastApi'
         - $ref: '#/targets/ContractTesting'
         - $ref: '#/targets/NestJS'
         - $ref: '#/targets/OpenAPI'
@@ -297,6 +298,20 @@ targets:
         - packageName
         - repositoryUrl
 
+  PythonFastApi:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: "^python-fastapi$"
+          packageName:
+            type: string
+          repositoryUrl:
+            type: string
+        required:
+        - packageName
+        - repositoryUrl
+
   ContractTesting:
     allOf:
       - $ref: '#/targets/Base'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "14.1.0-feature-csharp-functions-2e109dee.0",
+  "version": "14.1.0-feature-python-fastapi-6dc5992a.0",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",

package/targets/common.sh

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 # command line arguments:
 #   1. version - semantic version string
 #   2. binary - openapi-generator JAR file
@@ -21,10 +23,11 @@ templateDir=$9
 
 echo -e "\n=====\n  version:\t$version\n  binary:\t$binary\n  configFile:\t$configFile\n  targetId:\t$targetId\n generatorId:\t$generatorId\n openApiFile:\t$openApiFile\n  formatter:\t$formatterBinary\n  preRelease:\t$preRelease\n templateDir:\t$templateDir\n ---"
 
-for paramName in $(cat $configFile | jq -r ".targets[] | select(.id==\"$targetId\") | del(.id) | del(.type) | del(.source) | del(.generator) | del(.generatorId) | del(.templateDir) | keys | .[]"); do
-  result=$(cat $configFile | jq -r ".targets[] | select(.id==\"$targetId\") | .$paramName")
-  echo -e "  $paramName:\t$result"
-  eval $paramName="'$result'"
-done
+blacklist='.id, .type, .source, .generator, .generatorId, .templateDir'
+
+params=$(jq -r ".targets[] | select(.id == \"$targetId\") | del($blacklist) | to_entries | map(\"\(.key)=\(.value | @sh);\") | .[]" $configFile)
+
+echo "$params"
+eval $params
 
 echo -e "=====\n"

package/targets/python/generate.sh

@@ -2,9 +2,12 @@
 
 source $(dirname "$0")/../common.sh
 
-# change npm pre-release syntax (with - after semver) to python local syntax (with + after semver)
-version=$(echo $version | sed 's/-/\+/')
-echo "[NOTE] version updated to: ${version}"
+# if the version contains a `-` character, then use PEP 440 beta version syntax
+# example: 1.0.0-beta.1 -> 1.0.0b0+beta.1
+if [[ $version == *"-"* ]]; then
+  version=$(echo $version | sed 's/-/b0+/')
+  echo "[NOTE] version updated to: ${version}"
+fi
 
 rm -rf out/$targetId
 mkdir -p out/$targetId

package/targets/python-fastapi/generate.sh

@@ -0,0 +1,32 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+# if the version contains a `-` character, then use PEP 440 beta version syntax
+# example: 1.0.0-beta.1 -> 1.0.0b0+beta.1
+if [[ $version == *"-"* ]]; then
+  version=$(echo $version | sed 's/-/b0+/')
+  echo "[NOTE] version updated to: ${version}"
+fi
+
+rm -rf out/$targetId
+mkdir -p out/$targetId
+
+java -jar $binary generate \
+  -g $generatorId \
+  -i $openApiFile \
+  -t $templateDir \
+  -o out/$targetId \
+  -c $(dirname "$0")/generator-config.json \
+  -p "packageVersion=$version,packageName=$packageName" $generatorCustomArgs
+
+cd out/$targetId
+
+touch "src/$packageName/__init__.py"
+python3 -m venv venv
+source venv/bin/activate
+pip install --upgrade pip
+pip install flit==3.9.0
+flit build --no-use-vcs
+
+cd ../../

package/targets/python-fastapi/generator-config.json

@@ -0,0 +1,7 @@
+{
+  "inlineSchemaOptions": {
+    "ARRAY_ITEM_SUFFIX": "",
+    "MAP_ITEM_SUFFIX": "",
+    "SKIP_SCHEMA_REUSE": "true"
+  }
+}

package/targets/python-fastapi/publish.sh

@@ -0,0 +1,9 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+cd out/$targetId
+source venv/bin/activate
+pip install importlib_metadata==7.2.1 twine==4.0.2
+python3 -m twine upload --repository-url $repositoryUrl dist/*
+cd ../..

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/pyproject_toml.mustache

@@ -0,0 +1,35 @@
+[project]
+name = "{{packageName}}"
+version = "{{packageVersion}}"
+description = "{{appDescription}}"
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 88
+exclude = '''
+(
+  /(
+      \.eggs         # exclude a few common directories in the
+    | \.git          # root of the project
+    | \.hg
+    | \.mypy_cache
+    | \.tox
+    | \.venv
+    | _build
+    | buck-out
+    | build
+    | dist
+  )/
+)
+'''
+
+[tool.isort]
+profile = "black"
+skip = [
+    '.eggs', '.git', '.hg', '.mypy_cache', '.nox', '.pants.d', '.tox',
+    '.venv', '_build', 'buck-out', 'build', 'dist', 'node_modules', 'venv',
+]
+skip_gitignore = true

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

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