@team-supercharge/oasg 14.1.0-feature-python-fastapi-6dc5992a.0 → 14.1.0-fix-android-publishing-group-998336b0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -21
- package/bin/oasg +0 -1
- package/config.schema.yml +0 -15
- package/package.json +1 -1
- package/targets/android/templates/build.gradle.mustache +1 -1
- package/targets/python/generate.sh +3 -6
- package/targets/python-fastapi/generate.sh +0 -32
- package/targets/python-fastapi/generator-config.json +0 -7
- package/targets/python-fastapi/publish.sh +0 -9
- package/targets/python-fastapi/templates/README.mustache +0 -43
- package/targets/python-fastapi/templates/api.mustache +0 -62
- package/targets/python-fastapi/templates/base_api.mustache +0 -32
- package/targets/python-fastapi/templates/endpoint_argument_definition.mustache +0 -1
- package/targets/python-fastapi/templates/pyproject_toml.mustache +0 -35
- package/targets/python-fastapi/templates/requirements.mustache +0 -2
package/README.md
CHANGED
@@ -683,27 +683,6 @@ TBD
|
|
683
683
|
|
684
684
|
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.
|
685
685
|
|
686
|
-
|
687
|
-
#### `python-fastapi`
|
688
|
-
|
689
|
-
```json
|
690
|
-
{
|
691
|
-
"id": "server-python",
|
692
|
-
"type": "python-fastapi",
|
693
|
-
"source": "source-merged",
|
694
|
-
"packageName": "oasg_example",
|
695
|
-
"repositoryUrl": "https://gitlab.supercharge.io/api/v4/projects/1226/packages/pypi"
|
696
|
-
}
|
697
|
-
```
|
698
|
-
|
699
|
-
|Parameter| Description| Required | Default |
|
700
|
-
|-|-|-|-|
|
701
|
-
| packageName | Package nem for the project (convention: snake_case) | Y | - |
|
702
|
-
| repositoryUrl | URL of the PyPI repository | Y | - |
|
703
|
-
|
704
|
-
Building the distribution package requires Flit.
|
705
|
-
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.
|
706
|
-
|
707
686
|
#### `contract-testing`
|
708
687
|
|
709
688
|
```json
|
package/bin/oasg
CHANGED
@@ -47,7 +47,6 @@ const DEFAULT_GENERATOR_MAPPING = {
|
|
47
47
|
"nestjs": { version: '7.0.1', generator: 'typescript-angular' },
|
48
48
|
"spring": { version: '7.0.1', generator: 'spring' },
|
49
49
|
"spring-kotlin": { version: '7.0.1', generator: 'kotlin-spring' },
|
50
|
-
"python-fastapi": { version: '7.0.1', generator: 'python-fastapi' },
|
51
50
|
"dotnet": { version: '7.8.0', generator: 'csharp-functions' },
|
52
51
|
// misc targets
|
53
52
|
"contract-testing": { version: '4.3.1', generator: 'typescript-node' },
|
package/config.schema.yml
CHANGED
@@ -20,7 +20,6 @@ properties:
|
|
20
20
|
- $ref: '#/targets/Android'
|
21
21
|
- $ref: '#/targets/ios'
|
22
22
|
- $ref: '#/targets/Python'
|
23
|
-
- $ref: '#/targets/PythonFastApi'
|
24
23
|
- $ref: '#/targets/ContractTesting'
|
25
24
|
- $ref: '#/targets/NestJS'
|
26
25
|
- $ref: '#/targets/OpenAPI'
|
@@ -298,20 +297,6 @@ targets:
|
|
298
297
|
- packageName
|
299
298
|
- repositoryUrl
|
300
299
|
|
301
|
-
PythonFastApi:
|
302
|
-
allOf:
|
303
|
-
- $ref: '#/targets/Base'
|
304
|
-
- properties:
|
305
|
-
type:
|
306
|
-
pattern: "^python-fastapi$"
|
307
|
-
packageName:
|
308
|
-
type: string
|
309
|
-
repositoryUrl:
|
310
|
-
type: string
|
311
|
-
required:
|
312
|
-
- packageName
|
313
|
-
- repositoryUrl
|
314
|
-
|
315
300
|
ContractTesting:
|
316
301
|
allOf:
|
317
302
|
- $ref: '#/targets/Base'
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@team-supercharge/oasg",
|
3
|
-
"version": "14.1.0-
|
3
|
+
"version": "14.1.0-fix-android-publishing-group-998336b0.0",
|
4
4
|
"description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
|
5
5
|
"author": "Supercharge",
|
6
6
|
"license": "MIT",
|
@@ -2,12 +2,9 @@
|
|
2
2
|
|
3
3
|
source $(dirname "$0")/../common.sh
|
4
4
|
|
5
|
-
#
|
6
|
-
|
7
|
-
|
8
|
-
version=$(echo $version | sed 's/-/b0+/')
|
9
|
-
echo "[NOTE] version updated to: ${version}"
|
10
|
-
fi
|
5
|
+
# change npm pre-release syntax (with - after semver) to python local syntax (with + after semver)
|
6
|
+
version=$(echo $version | sed 's/-/\+/')
|
7
|
+
echo "[NOTE] version updated to: ${version}"
|
11
8
|
|
12
9
|
rm -rf out/$targetId
|
13
10
|
mkdir -p out/$targetId
|
@@ -1,32 +0,0 @@
|
|
1
|
-
#/bin/bash
|
2
|
-
|
3
|
-
source $(dirname "$0")/../common.sh
|
4
|
-
|
5
|
-
# if the version contains a `-` character, then use PEP 440 beta version syntax
|
6
|
-
# example: 1.0.0-beta.1 -> 1.0.0b0+beta.1
|
7
|
-
if [[ $version == *"-"* ]]; then
|
8
|
-
version=$(echo $version | sed 's/-/b0+/')
|
9
|
-
echo "[NOTE] version updated to: ${version}"
|
10
|
-
fi
|
11
|
-
|
12
|
-
rm -rf out/$targetId
|
13
|
-
mkdir -p out/$targetId
|
14
|
-
|
15
|
-
java -jar $binary generate \
|
16
|
-
-g $generatorId \
|
17
|
-
-i $openApiFile \
|
18
|
-
-t $templateDir \
|
19
|
-
-o out/$targetId \
|
20
|
-
-c $(dirname "$0")/generator-config.json \
|
21
|
-
-p "packageVersion=$version,packageName=$packageName" $generatorCustomArgs
|
22
|
-
|
23
|
-
cd out/$targetId
|
24
|
-
|
25
|
-
touch "src/$packageName/__init__.py"
|
26
|
-
python3 -m venv venv
|
27
|
-
source venv/bin/activate
|
28
|
-
pip install --upgrade pip
|
29
|
-
pip install flit==3.9.0
|
30
|
-
flit build --no-use-vcs
|
31
|
-
|
32
|
-
cd ../../
|
@@ -1,43 +0,0 @@
|
|
1
|
-
# OpenAPI generated FastAPI server
|
2
|
-
|
3
|
-
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
4
|
-
|
5
|
-
- API version: {{appVersion}}
|
6
|
-
{{^hideGenerationTimestamp}}
|
7
|
-
- Build date: {{generatedDate}}
|
8
|
-
{{/hideGenerationTimestamp}}
|
9
|
-
- Build package: {{generatorClass}}
|
10
|
-
|
11
|
-
## Requirements.
|
12
|
-
|
13
|
-
Python >= {{{generatorLanguageVersion}}}
|
14
|
-
|
15
|
-
## Installation & Usage
|
16
|
-
|
17
|
-
To run the server, please execute the following from the root directory:
|
18
|
-
|
19
|
-
```bash
|
20
|
-
pip3 install -r requirements.txt
|
21
|
-
pip3 install uvicorn
|
22
|
-
uvicorn --app-dir src {{packageName}}.main:app --host 0.0.0.0 --port {{serverPort}}
|
23
|
-
```
|
24
|
-
|
25
|
-
and open your browser at `http://localhost:{{serverPort}}/docs/` to see the docs.
|
26
|
-
|
27
|
-
## Running with Docker
|
28
|
-
|
29
|
-
To run the server on a Docker container, please execute the following from the root directory:
|
30
|
-
|
31
|
-
```bash
|
32
|
-
docker-compose up --build
|
33
|
-
```
|
34
|
-
|
35
|
-
## Tests
|
36
|
-
|
37
|
-
To run the tests:
|
38
|
-
|
39
|
-
```bash
|
40
|
-
pip3 install pytest
|
41
|
-
pip3 install httpx
|
42
|
-
PYTHONPATH=src pytest tests
|
43
|
-
```
|
@@ -1,62 +0,0 @@
|
|
1
|
-
# coding: utf-8
|
2
|
-
|
3
|
-
from typing import Dict, List # noqa: F401
|
4
|
-
import importlib
|
5
|
-
import pkgutil
|
6
|
-
|
7
|
-
from {{apiPackage}}.{{classFilename}}_{{baseSuffix}} import Base{{classname}}
|
8
|
-
|
9
|
-
from fastapi import ( # noqa: F401
|
10
|
-
APIRouter,
|
11
|
-
Body,
|
12
|
-
Cookie,
|
13
|
-
Depends,
|
14
|
-
Form,
|
15
|
-
Header,
|
16
|
-
Path,
|
17
|
-
Query,
|
18
|
-
Request,
|
19
|
-
Response,
|
20
|
-
Security,
|
21
|
-
status,
|
22
|
-
)
|
23
|
-
|
24
|
-
from {{modelPackage}}.extra_models import TokenModel # noqa: F401
|
25
|
-
{{#imports}}
|
26
|
-
{{import}}
|
27
|
-
{{/imports}}
|
28
|
-
|
29
|
-
router = APIRouter()
|
30
|
-
|
31
|
-
{{#operations}}
|
32
|
-
{{#operation}}
|
33
|
-
@router.{{#lambda.lowercase}}{{httpMethod}}{{/lambda.lowercase}}(
|
34
|
-
"{{path}}",
|
35
|
-
responses={
|
36
|
-
{{#responses}}
|
37
|
-
{{code}}: {{=<% %>=}}{<%#dataType%>"model": <%dataType%>, "description": "<%message%>"<%/dataType%><%^dataType%>"description": "<%message%>"<%/dataType%>}<%={{ }}=%>,
|
38
|
-
{{/responses}}
|
39
|
-
},
|
40
|
-
tags=[{{#tags}}"{{name}}"{{^-last}},{{/-last}}{{/tags}}],
|
41
|
-
{{#summary}}
|
42
|
-
summary="{{.}}",
|
43
|
-
{{/summary}}
|
44
|
-
{{#description}}
|
45
|
-
description = "{{.}}",
|
46
|
-
{{/description}}
|
47
|
-
response_model_by_alias=True,
|
48
|
-
)
|
49
|
-
async def {{operationId}}(
|
50
|
-
request: Request,
|
51
|
-
{{#allParams}}
|
52
|
-
{{>endpoint_argument_definition}},
|
53
|
-
{{/allParams}}
|
54
|
-
) -> Response: # -> {{returnType}}{{^returnType}}None{{/returnType}}
|
55
|
-
{{#notes}}"""{{.}}"""
|
56
|
-
return await Base{{classname}}.subclasses[0]().{{operationId}}(request{{#allParams}}, {{>impl_argument}}{{/allParams}}){{/notes}}{{^notes}}...{{/notes}}
|
57
|
-
{{^-last}}
|
58
|
-
|
59
|
-
|
60
|
-
{{/-last}}
|
61
|
-
{{/operation}}
|
62
|
-
{{/operations}}
|
@@ -1,32 +0,0 @@
|
|
1
|
-
# coding: utf-8
|
2
|
-
|
3
|
-
from typing import ClassVar, Dict, List, Tuple # noqa: F401
|
4
|
-
from fastapi import Request, Response
|
5
|
-
|
6
|
-
{{#imports}}
|
7
|
-
{{import}}
|
8
|
-
{{/imports}}
|
9
|
-
|
10
|
-
class Base{{classname}}:
|
11
|
-
subclasses: ClassVar[Tuple] = ()
|
12
|
-
|
13
|
-
def __init_subclass__(cls, **kwargs):
|
14
|
-
super().__init_subclass__(**kwargs)
|
15
|
-
Base{{classname}}.subclasses = Base{{classname}}.subclasses + (cls,)
|
16
|
-
|
17
|
-
{{#operations}}
|
18
|
-
{{#operation}}
|
19
|
-
async def {{operationId}}(
|
20
|
-
self,
|
21
|
-
request: Request,
|
22
|
-
{{#allParams}}
|
23
|
-
{{>impl_argument_definition}},
|
24
|
-
{{/allParams}}
|
25
|
-
) -> Response: # -> {{returnType}}{{^returnType}}None{{/returnType}}
|
26
|
-
{{#notes}}"""{{.}}"""
|
27
|
-
...{{/notes}}{{^notes}}...{{/notes}}
|
28
|
-
{{^-last}}
|
29
|
-
|
30
|
-
{{/-last}}
|
31
|
-
{{/operation}}
|
32
|
-
{{/operations}}
|
@@ -1 +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}})
|
@@ -1,35 +0,0 @@
|
|
1
|
-
[project]
|
2
|
-
name = "{{packageName}}"
|
3
|
-
version = "{{packageVersion}}"
|
4
|
-
description = "{{appDescription}}"
|
5
|
-
|
6
|
-
[build-system]
|
7
|
-
requires = ["setuptools", "wheel"]
|
8
|
-
build-backend = "setuptools.build_meta"
|
9
|
-
|
10
|
-
[tool.black]
|
11
|
-
line-length = 88
|
12
|
-
exclude = '''
|
13
|
-
(
|
14
|
-
/(
|
15
|
-
\.eggs # exclude a few common directories in the
|
16
|
-
| \.git # root of the project
|
17
|
-
| \.hg
|
18
|
-
| \.mypy_cache
|
19
|
-
| \.tox
|
20
|
-
| \.venv
|
21
|
-
| _build
|
22
|
-
| buck-out
|
23
|
-
| build
|
24
|
-
| dist
|
25
|
-
)/
|
26
|
-
)
|
27
|
-
'''
|
28
|
-
|
29
|
-
[tool.isort]
|
30
|
-
profile = "black"
|
31
|
-
skip = [
|
32
|
-
'.eggs', '.git', '.hg', '.mypy_cache', '.nox', '.pants.d', '.tox',
|
33
|
-
'.venv', '_build', 'buck-out', 'build', 'dist', 'node_modules', 'venv',
|
34
|
-
]
|
35
|
-
skip_gitignore = true
|