essentials-openapi

from essentials_openapi.v3 import OpenAPI, Info, PathItem, Operation, Response, MediaType, Schema, Contact from essentials_openapi.v3.models import Reference # Define contact information contact_info = Contact(name='API Support', email='support@example.com') # Define basic API information info = Info( title='My Sample API', version='1.0.0', description='A simple API to demonstrate essentials-openapi.', contact=contact_info ) # Define a simple response schema success_schema = Schema(type='object', properties={'message': Schema(type='string')}) # Define a successful response success_response = Response( description='Successful operation', content={'application/json': MediaType(schema=Reference(ref='#/components/schemas/SuccessResponse'))} ) # Define an operation for a GET endpoint get_operation = Operation( summary='Get a greeting', responses={'200': success_response} ) # Define a path item path_item = PathItem(get=get_operation) # Create the OpenAPI object openapi = OpenAPI( info=info, paths={'/greet': path_item}, components={'schemas': {'SuccessResponse': success_schema}} ) # Generate the OpenAPI JSON output openapi_json = openapi.to_json(indent=2) print(openapi_json) # To save to a file (requires PyYAML for YAML, or built-in json for JSON) # with open('openapi.json', 'w') as f: # f.write(openapi_json)