dart_frog_open_api 0.1.5
dart_frog_open_api: ^0.1.5 copied to clipboard
OpenAPI/Swagger spec generator for Dart Frog — file-system based route scanning.
Changelog #
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
0.1.5 #
Changed #
- Breaking: the sorting/expansion options are now type-safe enums instead of raw
strings —
swaggerUiHandler(docExpansion:)takesSwaggerDocExpansion(.none/.list/.full), andScalarOptions.tagsSorter/ScalarOptions.operationsSortertakeScalarTagsSorter/ScalarOperationsSorter
0.1.4 #
Added #
ScalarOptions.tagsSorter(default'alpha') andScalarOptions.operationsSorterso the Scalar sidebar is alphabetized regardless of spec order — Scalar does not honour the top-leveltagsarray ordering on its owndocExpansionparameter onswaggerUiHandler('none'/'list'/'full') to control whether Swagger UI sections start collapsed or expanded
Changed #
- Swagger UI now emits
tagsSorter: "alpha"andoperationsSorter: "alpha"
0.1.2 #
Added #
- Top-level
tagslist in the generated OpenAPI spec, sorted alphabetically (case-insensitive), so tag groups are auto-grouped and ordered in Scalar / Swagger UI
0.1.1 #
- UPDATE README
0.1.0 #
Added #
- Initial release
- File-system based route scanning for Dart Frog (
routes/) - OpenAPI 3.0 JSON spec generation (
openApiJsonHandler) - Swagger UI and Scalar UI handlers (
swaggerUiHandler,scalarUiHandler) - Fluent route documentation API (
Api.path()) and direct constructors (PathSchema/OperationSchema) - Automatic DTO schemas via
zto, with recursive$refresolution for nested DTOs - Postman v2.1 and Bruno collection export (with test / pre-request scripts)
SecurityConfig— secure by default (404 until explicitly enabled), optional guard, CORS allowlist, security headers and spec caching- Declarative security schemes (
OpenApiSecurity.bearer,apiKey*,oauth2*)