dart_frog_open_api 0.1.5 copy "dart_frog_open_api: ^0.1.5" to clipboard
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:) takes SwaggerDocExpansion (.none / .list / .full), and ScalarOptions.tagsSorter / ScalarOptions.operationsSorter take ScalarTagsSorter / ScalarOperationsSorter

0.1.4 #

Added #

  • ScalarOptions.tagsSorter (default 'alpha') and ScalarOptions.operationsSorter so the Scalar sidebar is alphabetized regardless of spec order — Scalar does not honour the top-level tags array ordering on its own
  • docExpansion parameter on swaggerUiHandler ('none' / 'list' / 'full') to control whether Swagger UI sections start collapsed or expanded

Changed #

  • Swagger UI now emits tagsSorter: "alpha" and operationsSorter: "alpha"

0.1.2 #

Added #

  • Top-level tags list 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 $ref resolution 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*)
0
likes
160
points
286
downloads

Documentation

Documentation
API reference

Publisher

verified publisherartizansoftwares.com

Weekly Downloads

OpenAPI/Swagger spec generator for Dart Frog — file-system based route scanning.

Homepage
Repository (GitHub)
View/report issues

Topics

#dart-frog #openapi #swagger #documentation

License

MIT (license)

Dependencies

archive, dart_frog, zto

More

Packages that depend on dart_frog_open_api