@team-supercharge/oasg 13.2.0-feature-python-fastapi-064d0bcc.0 → 13.2.0-feature-csharp-functions-00ba5a99.0

package/README.md

@@ -656,27 +656,6 @@ 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
@@ -792,6 +771,23 @@ describe('Auth', function () {
 |-|-|-|-|
 | fileName | Name of the generated file | N | `openapi.yaml` |
 
+#### `csharp-functions`
+
+```json
+{
+  "id": "csharp-functions",
+  "type": "csharp-functions",
+  "source": "source-merged",
+  "packageName": "Oasg.Example",
+  "generatorCustomArgs": "--additional-properties=packageName=$packageName"
+}
+```
+
+|Parameter| Description| Required | Default |
+|-|-|-|-|
+| packageName | C# package name (convention: Title.Case). | Y | - |
+| generatorCustomArgs | Custom arguments of the generator | N | - |
+
 ---
 
 # Migration Guide

package/bin/oasg

@@ -45,7 +45,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' },
+  "csharp-functions": { version: '7.0.1',   generator: 'csharp-functions' },
   // misc targets
   "contract-testing": { version: '4.3.1',   generator: 'typescript-node' },
   "openapi":          { version: undefined, generator: undefined },

package/config.schema.yml

@@ -20,11 +20,11 @@ properties:
         - $ref: '#/targets/Android'
         - $ref: '#/targets/ios'
         - $ref: '#/targets/Python'
-        - $ref: '#/targets/PythonFastApi'
         - $ref: '#/targets/ContractTesting'
         - $ref: '#/targets/NestJS'
         - $ref: '#/targets/OpenAPI'
         - $ref: '#/targets/Flutter'
+        - $ref: '#/targets/CsharpFunctions'
 required:
   - targets
 additionalProperties: false
@@ -296,20 +296,6 @@ 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'
@@ -361,6 +347,17 @@ targets:
         - packageName
         - repository
 
+  CsharpFunctions:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: '^csharp-functions$'
+          packageName:
+            type: string
+        required:
+          - packageName
+
 definitions:
   # default
   SourceOverrides:

package/package.json

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

package/targets/csharp-functions/generate.sh

@@ -0,0 +1,15 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+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

package/targets/{python-fastapi → csharp-functions}/generator-config.json

@@ -1,4 +1,5 @@
 {
+  "global-property": "models",
   "inlineSchemaOptions": {
     "ARRAY_ITEM_SUFFIX": "",
     "MAP_ITEM_SUFFIX": "",

package/targets/csharp-functions/publish.sh

@@ -0,0 +1,12 @@
+#/bin/bash
+
+# source $(dirname "$0")/../common.sh
+
+# TODO install dotnet, nuget
+
+# cd out/$targetId
+# dotnet pack
+# nuget push YourPackage.nupkg -Source https://api.nuget.org/v3/index.json
+# cd ../..
+
+echo "Publish .NET"

package/targets/nestjs/templates/pipes.ts

@@ -77,7 +77,7 @@ export class OptionalParseBoolPipe implements PipeTransform<string | boolean> {
   }
 }
 
-export class OptionalParseEnumPipe<T = any> implements PipeTransform<T> {
+export class OptionalParseEnumPipe<T extends { [key: string]: any } = any> implements PipeTransform<T> {
   constructor(private readonly enumType: T) {
     if (!enumType) {
       throw new Error(

package/targets/python-fastapi/generate.sh

@@ -1,29 +0,0 @@
-#/bin/bash
-
-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}"
-
-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/publish.sh

@@ -1,9 +0,0 @@
-#/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

@@ -1,43 +0,0 @@
-# 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

@@ -1,62 +0,0 @@
-# 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){{/notes}}{{^notes}}...{{/notes}}
-{{^-last}}
-
-
-{{/-last}}
-{{/operation}}
-{{/operations}}

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

@@ -1,29 +0,0 @@
-# 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,
-    ) -> Response: # -> {{returnType}}{{^returnType}}None{{/returnType}}
-        {{#notes}}"""{{.}}"""
-        ...{{/notes}}{{^notes}}...{{/notes}}
-{{^-last}}
-
-{{/-last}}
-{{/operation}}
-{{/operations}}

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

@@ -1 +0,0 @@
-{{#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

@@ -1,35 +0,0 @@
-[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

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