Usage
From command line
spec2sdk --input-file path/to/api.yml --output-dir path/to/output-dir/
From the code
from pathlib import Path
from spec2sdk.main import generate
generate(input_file=Path("path/to/api.yml"), output_dir=Path("path/to/output-dir/"))
Open API specification requirements
Operation ID
operationId must be specified for each endpoint to generate meaningful method names. It must be unique among all operations described in the API.
Input
paths:
/health:
get:
operationId: healthCheck
responses:
'200':
description: Successful response
Output
class APIClient:
def health_check(self) -> None:
...
Inline schemas
Inline schemas should be annotated with the schema name in the x-schema-name field that doesn't overlap with the existing schema names in the specification.
Input
paths:
/me:
get:
operationId: getMe
responses:
'200':
description: Successful response
content:
application/json:
schema:
x-schema-name: User
type: object
properties:
name:
type: string
email:
type: string
Output
class User(Model):
name: str | None = Field(default=None)
email: str | None = Field(default=None)
Enum variable names
Variable names for enums can be specified by the x-enum-varnames field.
Input
components:
schemas:
Direction:
x-enum-varnames: [ NORTH, SOUTH, WEST, EAST ]
type: string
enum: [ N, S, W, E ]
Output
from enum import StrEnum
class Direction(StrEnum):
NORTH = "N"
SOUTH = "S"
WEST = "W"
EAST = "E"
Custom types
Register Python converters and renderers to implement custom types.
Input
components:
schemas:
User:
type: object
properties:
name:
type: string
email:
type: string
format: email
from pathlib import Path
from spec2sdk.parsers.entities import DataType, StringDataType
from spec2sdk.generators.converters import converters
from spec2sdk.generators.entities import PythonType
from spec2sdk.generators.predicates import is_instance
from spec2sdk.generators.imports import Import
from spec2sdk.generators.models.entities import TypeRenderer
from spec2sdk.generators.models.renderers import render_root_model, renderers
from spec2sdk.main import generate
class EmailPythonType(PythonType):
pass
def is_email_format(data_type: DataType) -> bool:
return isinstance(data_type, StringDataType) and data_type.format == "email"
@converters.register(predicate=is_email_format)
def convert_email_field(data_type: StringDataType) -> EmailPythonType:
return EmailPythonType(
name=None,
type_hint="EmailStr",
description=data_type.description,
default_value=data_type.default_value,
)
@renderers.register(predicate=is_instance(EmailPythonType))
def render_email_field(py_type: EmailPythonType) -> TypeRenderer:
return render_root_model(
py_type,
extra_imports=(Import(name="EmailStr", package="pydantic"),),
content="EmailStr",
)
if __name__ == "__main__":
generate(input_file=Path("api.yml"), output_dir=Path("output"))
Output
from pydantic import EmailStr, Field
class User(Model):
name: str | None = Field(default=None)
email: EmailStr | None = Field(default=None)
1 maintainer
Metadata
1 maintainer
Release files for spec2sdk 1.0.202410080750
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| spec2sdk-1.0.202410080750.tar.gz | 15.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| spec2sdk-1.0.202410080750-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 37.1 kB
Release files / spec2sdk-1.0.202410080750.tar.gz
| Download URL | spec2sdk-1.0.202410080750.tar.gz |
|---|---|
| Size | 15.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
84d4518524898098827bf4169775e4c65da1339e2483cced93ff58cd27d7aa34
|
|
BLAKE2b-256 checksum How to use checksums |
2b506d62d2f9d8ac49e2312a4fc3daeef3ee617477d2c6410e8b25ef67e69873
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-1014-azure
|
Release files / spec2sdk-1.0.202410080750-py3-none-any.whl
| Download URL | spec2sdk-1.0.202410080750-py3-none-any.whl |
|---|---|
| Size | 22.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1ca71723d487792f0289df485acd78fa115fe73cc907c913d74d5973389d8b50
|
|
BLAKE2b-256 checksum How to use checksums |
c6b4796ec7444b99b2b43046942bfa772b25d322d4adcf25a9d0101a60bcfe6d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-1014-azure
|
