openapi_spec 0.7.18 copy "openapi_spec: ^0.7.18" to clipboard
openapi_spec: ^0.7.18 copied to clipboard

OpenAPI Specification generator using native Dart code, as well as an all-in-one parser of existing specifications.

3
likes
140/ 160
pub points
56%
popularity

We analyzed this package 10 hours ago, and awarded it 140 pub points (of a possible 160):

OK
Follow Dart file conventions
30 / 30trigger folding of the section

10/10 points: Provide a valid pubspec.yaml

5/5 points: Provide a valid README.md

5/5 points: Provide a valid CHANGELOG.md

10/10 points: Use an OSI-approved license

Detected license: BSD-3-Clause.

OK
Provide documentation
20 / 20trigger folding of the section

10/10 points: 20% or more of the public API has dartdoc comments

189 out of 415 API elements (45.5 %) have documentation comments.

Some symbols that are missing documentation: openapi_spec.ApiCallback.copyWith, openapi_spec.ApiCallback.map, openapi_spec.ApiCallback.mapOrNull, openapi_spec.ApiCallback.maybeMap, openapi_spec.ApiKeyLocation.

10/10 points: Package has an example

OK
Platform support
20 / 20trigger folding of the section

20/20 points: Supports 5 of 6 possible platforms (iOS, Android, Web, Windows, macOS, Linux)

  • ✓ Android
  • ✓ iOS
  • ✓ Windows
  • ✓ Linux
  • ✓ macOS

These platforms are not supported:

Package not compatible with platform Web

Because:

  • package:openapi_spec/openapi_spec.dart that imports:
  • package:openapi_spec/src/generators/index.dart that imports:
  • package:openapi_spec/src/open_api/index.dart that imports:
  • dart:isolate
failed
Pass static analysis
30 / 50trigger folding of the section

30/50 points: code has no errors, warnings, lints, or formatting issues

Found 68 issues. Showing the first 2:

WARNING: The annotation 'JsonKey' can only be used on fields or getters.

lib/src/open_api/example.dart:30:6

   ╷
30 │     @JsonKey(name: '\$ref') @_ExampleRefConverter() String? ref,
   │      ^^^^^^^
   ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/open_api/example.dart

WARNING: The annotation 'JsonKey' can only be used on fields or getters.

lib/src/open_api/link.dart:12:6

   ╷
12 │     @JsonKey(name: '\$ref') @_LinkRefConverter() String? ref,
   │      ^^^^^^^
   ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/open_api/link.dart

OK
Support up-to-date dependencies
40 / 40trigger folding of the section

10/10 points: All of the package dependencies are supported in the latest version

Package Constraint Compatible Latest
collection ^1.17.1 1.19.0 1.19.0
freezed_annotation ^2.4.1 2.4.2 2.4.2
http >=0.13.0 <2.0.0 1.2.1 1.2.1
intl >=0.17.0 <1.0.0 0.19.0 0.19.0
json_annotation ^4.8.1 4.9.0 4.9.0
path >=1.8.0 <2.0.0 1.9.0 1.9.0
recase ^4.1.0 4.1.0 4.1.0
yaml ^3.1.2 3.1.2 3.1.2
Transitive dependencies
Package Constraint Compatible Latest
async - 2.11.0 2.11.0
clock - 1.1.1 1.1.1
http_parser - 4.1.0 4.1.0
meta - 1.15.0 1.15.0
source_span - 1.10.0 1.10.0
string_scanner - 1.2.0 1.2.0
term_glyph - 1.2.1 1.2.1
typed_data - 1.3.2 1.3.2
web - 0.5.1 0.5.1

To reproduce run dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides.

10/10 points: Package supports latest stable Dart and Flutter SDKs

20/20 points: Compatible with dependency constraint lower bounds

pub downgrade does not expose any static analysis error.

Analyzed with Pana 0.22.7, Dart 3.4.4.

Check the analysis log for details.

3
likes
140
pub points
56%
popularity

Publisher

verified publishertazatechnology.com

OpenAPI Specification generator using native Dart code, as well as an all-in-one parser of existing specifications.

Homepage
Repository (GitHub)
View/report issues

Documentation

Documentation
API reference

License

BSD-3-Clause (LICENSE)

Dependencies

collection, freezed_annotation, http, intl, json_annotation, path, recase, yaml

More

Packages that depend on openapi_spec