api_guide 1.1.8 copy "api_guide: ^1.1.8" to clipboard
api_guide: ^1.1.8 copied to clipboard

API Guide is package to generate API calls documentations like OpenAPI schema.

140/ 160
pub points
52
downloads

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

Passed report section
Follow Dart file conventions
30 / 30trigger folding of the section

Passed check 10/10 points: Provide a valid pubspec.yaml

Passed check 5/5 points: Provide a valid README.md

Passed check 5/5 points: Provide a valid CHANGELOG.md

Passed check 10/10 points: Use an OSI-approved license

Detected license: MIT.

Passed report section
Provide documentation
20 / 20trigger folding of the section

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

376 out of 378 API elements (99.5 %) have documentation comments.

Some symbols that are missing documentation: api_guide, api_guide.APIGuideFAQ.

Passed check 10/10 points: Package has an example and has no issues with screenshots

Passed report section
Platform support
20 / 20trigger folding of the section

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

  • ✓ Android

  • ✓ iOS

  • ✓ Windows

  • ✓ Linux

  • ✓ macOS

  • ✓ Web

Passed check 0/0 points: WASM compatibility

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

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

Partially passed report section
Pass static analysis
40 / 50trigger folding of the section

Partially passed check 40/50 points: code has no errors, warnings, lints, or formatting issues

Found 23 issues. Showing the first 2:

INFO: Missing type annotation.

lib/src/application/app_provider.dart:78:1

   ╷
78 │ updateAPIItemAndKeys(List<APIItem> val, WidgetRef ref) {
   │ ^^^^^^^^^^^^^^^^^^^^
   ╵

To reproduce make sure you are using the lints_core and run flutter analyze lib/src/application/app_provider.dart

INFO: Missing type annotation.

lib/src/application/app_provider.dart:117:1

    ╷
117 │ updateAPIItemWithSecurity(List<APIItem> val, WidgetRef ref) {
    │ ^^^^^^^^^^^^^^^^^^^^^^^^^
    ╵

To reproduce make sure you are using the lints_core and run flutter analyze lib/src/application/app_provider.dart

Failed report section
Support up-to-date dependencies
30 / 40trigger folding of the section

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

Package Constraint Compatible Latest Notes
flutter_markdown ^0.7.1 0.7.7+1 0.7.7+1 Discontinued
flutter_riverpod ^2.5.1 2.6.1 3.0.1
markdown ^7.2.2 7.3.0 7.3.0
url_launcher ^6.2.6 6.3.2 6.3.2
Transitive dependencies
Package Constraint Compatible Latest Notes
args - 2.7.0 2.7.0
characters - 1.4.0 1.4.1
collection - 1.19.1 1.19.1
material_color_utilities - 0.11.1 0.13.0
meta - 1.16.0 1.17.0
path - 1.9.1 1.9.1
plugin_platform_interface - 2.1.8 2.1.8
riverpod - 2.6.1 3.0.1
stack_trace - 1.12.1 1.12.1
state_notifier - 1.0.0 1.0.0
url_launcher_android - 6.3.23 6.3.23
url_launcher_ios - 6.3.4 6.3.4
url_launcher_linux - 3.2.1 3.2.1
url_launcher_macos - 3.2.3 3.2.3
url_launcher_platform_interface - 2.3.2 2.3.2
url_launcher_web - 2.4.1 2.4.1
url_launcher_windows - 3.1.4 3.1.4
vector_math - 2.2.0 2.2.0
web - 1.1.1 1.1.1

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

The constraint `^2.5.1` on flutter_riverpod does not support the stable version `3.0.0`, that was published 22 days ago.

When flutter_riverpod is 30 days old, this package will no longer be awarded points in this category.

Try running dart pub upgrade --major-versions flutter_riverpod to update the constraint.

The package has one or more discontinued direct dependencies.

Discontinued packages are no longer maintained, and can end up being a liability.

Consider migrating away from these dependencies:

  • flutter_markdown.

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

Passed check 20/20 points: Compatible with dependency constraint lower bounds

pub downgrade does not expose any static analysis error.

Analyzed with Pana 0.22.23, Flutter 3.35.5, Dart 3.9.2.

Check the analysis log for details.

Weekly downloads

Display as:
By versions:
17
likes
140
points
52
downloads
screenshot

Publisher

unverified uploader

Weekly Downloads

API Guide is package to generate API calls documentations like OpenAPI schema.

Repository (GitHub)
View/report issues

Topics

#api #documentation #integration-api-guide

Documentation

API reference

License

MIT (license)

Dependencies

flutter, flutter_markdown, flutter_riverpod, markdown, url_launcher

More

Packages that depend on api_guide