openapi_base 2.0.0 copy "openapi_base: ^2.0.0" to clipboard
openapi_base: ^2.0.0 copied to clipboard

Open API base implementation for client/server to be used with openapi_code_builder.

3
likes
130/ 160
pub points
379
downloads

We analyzed this package 4 days ago, and awarded it 130 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: MIT.

partial
Provide documentation
10 / 20trigger folding of the section

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

32 out of 271 API elements (11.8 %) have documentation comments.

Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API. Document at least 20% of the public API elements.

To highlight public API members missing documentation consider enabling the public_member_api_docs lint.

Some symbols that are missing documentation: openapi_base, openapi_base.ApiEndpoint, openapi_base.ApiEndpoint.ApiEndpoint, openapi_base.ApiEndpointCallback, openapi_base.ApiEndpointProvider.

10/10 points: Package has an example

failed
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_base/openapi_base.dart that imports:
  • package:openapi_base/src/server/openapi_shelf_noop_server.dart that imports:
  • package:openapi_base/src/server/openapi_server_base.dart that imports:
  • dart:io

0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

  • package:openapi_base/openapi_base.dart that imports:
  • package:openapi_base/src/server/openapi_shelf_noop_server.dart that imports:
  • package:openapi_base/src/server/openapi_server_base.dart that imports:
  • dart:io

This package is not compatible with runtime wasm, and will not be rewarded full points in a future version of the scoring model.

See https://dart.dev/web/wasm for details.

OK
Pass static analysis
50 / 50trigger folding of the section

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

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

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

Package Constraint Compatible Latest
chunked_stream >=1.4.1 <2.0.0 1.4.2 1.4.2
collection >=1.16.0 <2.0.0 1.19.1 1.19.1
http >=0.13.0 <2.0.0 1.2.2 1.2.2
http_parser >=4.0.0 <5.0.0 4.1.1 4.1.1
json_annotation >=4.0.0 <6.0.0 4.9.0 4.9.0
logging >=1.0.0 <2.0.0 1.3.0 1.3.0
logging_appenders >=1.0.0 <2.0.0 1.3.1 1.3.1
meta >=1.3.0 <2.0.0 1.16.0 1.16.0
open_api_forked >=3.0.0 <4.0.0 3.0.0+6 3.0.0+6
shelf >=1.0.0 <2.0.0 1.4.2 1.4.2
uri ^1.0.0 1.0.0 1.0.0
uuid >=4.0.0 <5.0.0 4.5.1 4.5.1
Transitive dependencies
Package Constraint Compatible Latest
async - 2.12.0 2.12.0
boolean_selector - 2.1.2 2.1.2
clock - 1.1.2 1.1.2
codable_forked - 1.0.0+3 1.0.0+3
crypto - 3.0.6 3.0.6
dio - 5.7.0 5.7.0
dio_web_adapter - 2.0.0 2.0.0
fixnum - 1.1.1 1.1.1
intl - 0.20.1 0.20.1
matcher - 0.12.17 0.12.17
path - 1.9.1 1.9.1
quiver - 3.2.2 3.2.2
source_span - 1.10.1 1.10.1
sprintf - 7.0.0 7.0.0
stack_trace - 1.12.1 1.12.1
stream_channel - 2.1.3 2.1.3
string_scanner - 1.4.1 1.4.1
term_glyph - 1.2.2 1.2.2
test_api - 0.7.4 0.7.4
typed_data - 1.4.0 1.4.0
web - 1.1.0 1.1.0

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

0/20 points: Compatible with dependency constraint lower bounds

downgrade analysis failed failed with 1 error:

  • UNDEFINED_NAMED_PARAMETER - lib/src/server/openapi_shelf_server.dart:55:7 - The named parameter 'poweredByHeader' isn't defined.

Run dart pub downgrade and then dart analyze to reproduce the above problem.

You may run dart pub upgrade --tighten to update your dependency constraints, see dart.dev/go/downgrade-testing for details.

Analyzed with Pana 0.22.17, Dart 3.6.0.

Check the analysis log for details.

3
likes
130
points
379
downloads

Publisher

verified publishercodeux.design

Weekly Downloads

Open API base implementation for client/server to be used with openapi_code_builder.

Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (license)

Dependencies

chunked_stream, collection, http, http_parser, json_annotation, logging, logging_appenders, meta, open_api_forked, shelf, uri, uuid

More

Packages that depend on openapi_base