Usage

From command line

spec2sdk --input path/to/api.yml --output-dir path/to/output-dir/

From the code

from pathlib import Path
from spec2sdk.main import generate

generate(url=Path("path/to/api.yml").absolute().as_uri(), 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

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(url=Path("api.yml").absolute().as_uri(), 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)

Metadata

Release files for spec2sdk 1.0.202410301243

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for spec2sdk 1.0.202410301243
File	Size	Uploaded
spec2sdk-1.0.202410301243.tar.gz	16.0 kB	Oct 30, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for spec2sdk 1.0.202410301243
File	Interpreter	ABI	Platform	Reset
spec2sdk-1.0.202410301243-py3-none-any.whl 23.0 kB Oct 30, 2024	Python 3	none	any	Details

Total release size: 39.0 kB

Release files / spec2sdk-1.0.202410301243.tar.gz

Download URL	spec2sdk-1.0.202410301243.tar.gz
Size	16.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`b9ee51fe97c029002025d3b239ea2cd1a239f3b17bbe2da84f3994785329c85e`
BLAKE2b-256 checksum How to use checksums	`95462863a6304fb85d091f7238104b5bf92589223ad6157b1c42837481049256`
Upload date	Oct 30, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-1015-azure`

Release files / spec2sdk-1.0.202410301243-py3-none-any.whl

Download URL	spec2sdk-1.0.202410301243-py3-none-any.whl
Size	23.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`33feaf3e0fffffca5670231447084f5c4de868fcc38ec84e20b70dc70e07a218`
BLAKE2b-256 checksum How to use checksums	`617aca97efaac0d8a7f281c2376a713bfa179faf946073ce8fe2ed0f6565e8c8`
Upload date	Oct 30, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-1015-azure`