# OpenAPI export RAMOSE can export your API definition as an [OpenAPI 3.2](https://spec.openapis.org/oas/v3.2.0) YAML document. This lets you plug into the OpenAPI ecosystem: Swagger UI, client generators, API gateways, and so on. ## From the CLI ```sh python -m ramose -s api.hf --openapi -o openapi.yaml ``` When multiple spec files are loaded, use `--api-base` to select which one to export: ```sh python -m ramose -s api_v1.hf api_v2.hf --openapi --api-base /api/v1 -o openapi.yaml ``` ## From the web server The OpenAPI spec is served automatically at `/openapi.yaml`: ``` http://localhost:8080/api/v1/openapi.yaml ``` Also accessible as `openapi.yml`. ## What gets exported The generated document includes: - API metadata (`info.title`, `info.version`, `info.description`, `info.contact`, `info.license`) - Server URLs derived from `#base` and `#url` - One path per operation, with parameters extracted from the URL template - Parameter schemas inferred from `#` type declarations - Example values extracted from `#call` - Response schemas with field types from `#field_type` - Response content types: built-in `application/json` and `text/csv`, plus any custom format that declares a media type (the third field of `#format`). Custom formats without a media type still appear among the `?format` query parameter values but not in the response content RAMOSE-specific implementation details (endpoint, addon, method, preprocess, postprocess) are intentionally omitted from the output as they are not meaningful to API consumers.