class -> OAS

Automatically generate OAS from python class implementation via OpenAI API

class Item:
    def __init__(self, name: str, price: float, quantity: int):
        self.name = name
        self.price = price
        self.quantity = quantity

    def get_total_price(self) -> float:
        return self.price * self.quantity

item = Item("shoes", 49.0, 2)
item.get_total_price()

98.0

res = api.chat.completions.create(
    model="gpt-4o",
    messages=[
        {"role": "system", "content": "You are an assistant that generates OpenAPI specs."},
        {"role": "user", "content": content}
    ]
)

res = json.loads(res.json())['choices'][0]['message']['content']
res = res.replace("```yaml", "").replace("```", "").strip()

/tmp/ipykernel_32782/138741873.py:10: PydanticDeprecatedSince20: The `json` method is deprecated; use `model_dump_json` instead. Deprecated in Pydantic V2.0 to be removed in V3.0. See Pydantic V2 Migration Guide at https://errors.pydantic.dev/2.10/migration/
  res = json.loads(res.json())['choices'][0]['message']['content']

#print(res)

# !pip install -qq pyyaml openapi-spec-validator

def validate_yaml(yaml_buffer):
    try:
        yaml_content = yaml.safe_load(yaml_buffer)
        print("YAML syntax is valid.")
        return yaml_content
    except yaml.YAMLError as e:
        print("YAML syntax error:", e)
        return None

def validate_oas(yaml_content):
    try:
        validate_spec(yaml_content)
        print("OpenAPI specification format is valid.")
    except Exception as e:
        print("OpenAPI validation error:", e)

yaml_content = validate_yaml(res)
if yaml_content:
    validate_oas(yaml_content)

YAML syntax is valid.
OpenAPI specification format is valid.

with open("oas.yaml", "w") as f:
    yaml.dump(yaml_content, f)

Other Formats