api_guide 1.1.8 
api_guide: ^1.1.8 copied to clipboard
API Guide is package to generate API calls documentations like OpenAPI schema.
We analyzed this package 5 days ago, and awarded it 150 pub points (of a possible 160):
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.
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.
10/10 points: Package has an example and has no issues with screenshots
20/20 points: Supports 6 of 6 possible platforms (iOS, Android, Web, Windows, macOS, Linux)
-
✓ Android
-
✓ iOS
-
✓ Windows
-
✓ Linux
-
✓ macOS
-
✓ Web
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.dev/web/wasm for details.
40/50 points: code has no errors, warnings, lints, or formatting issues
Found 7 issues. Showing the first 2:
INFO: Angle brackets will be interpreted as HTML.
lib/src/domain/api_item.dart:8:41
╷
8 │ /// Define [response] property as List<APIGuideResponse> and final
│ ^^^^^^^^^^^^^^^^^^
╵
To reproduce make sure you are using the lints_core and run flutter analyze lib/src/domain/api_item.dart
INFO: Angle brackets will be interpreted as HTML.
lib/src/domain/api_item.dart:11:48
╷
11 │ /// Define [securitySchemes] property as List<APISecurityScheme> and final
│ ^^^^^^^^^^^^^^^^^^^
╵
To reproduce make sure you are using the lints_core and run flutter analyze lib/src/domain/api_item.dart
10/10 points: All of the package dependencies are supported in the latest version
| Package | Constraint | Compatible | Latest |
|---|---|---|---|
flutter |
flutter |
0.0.0 | 0.0.0 |
flutter_markdown |
^0.7.1 |
0.7.6+2 | 0.7.6+2 |
flutter_riverpod |
^2.5.1 |
2.6.1 | 2.6.1 |
markdown |
^7.2.2 |
7.3.0 | 7.3.0 |
url_launcher |
^6.2.6 |
6.3.1 | 6.3.1 |
Transitive dependencies
| Package | Constraint | Compatible | Latest |
|---|---|---|---|
args |
- | 2.6.0 | 2.6.0 |
characters |
- | 1.3.0 | 1.4.0 |
collection |
- | 1.19.0 | 1.19.1 |
flutter_web_plugins |
- | 0.0.0 | 0.0.0 |
material_color_utilities |
- | 0.11.1 | 0.12.0 |
meta |
- | 1.15.0 | 1.16.0 |
path |
- | 1.9.1 | 1.9.1 |
plugin_platform_interface |
- | 2.1.8 | 2.1.8 |
riverpod |
- | 2.6.1 | 2.6.1 |
sky_engine |
- | 0.0.0 | 0.0.0 |
stack_trace |
- | 1.12.1 | 1.12.1 |
state_notifier |
- | 1.0.0 | 1.0.0 |
url_launcher_android |
- | 6.3.14 | 6.3.14 |
url_launcher_ios |
- | 6.3.2 | 6.3.2 |
url_launcher_linux |
- | 3.2.1 | 3.2.1 |
url_launcher_macos |
- | 3.2.2 | 3.2.2 |
url_launcher_platform_interface |
- | 2.3.2 | 2.3.2 |
url_launcher_web |
- | 2.4.0 | 2.4.0 |
url_launcher_windows |
- | 3.1.4 | 3.1.4 |
vector_math |
- | 2.1.4 | 2.1.4 |
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
20/20 points: Compatible with dependency constraint lower bounds
pub downgrade does not expose any static analysis error.
Analyzed with Pana 0.22.18, Flutter 3.27.4, Dart 3.6.2.
Check the analysis log for details.
Weekly downloads
Metadata
Publisher
unverified uploader
Weekly Downloads
Metadata
API Guide is package to generate API calls documentations like OpenAPI schema.
Repository (GitHub)
View/report issues
Topics
#api #documentation #integration-api-guide
Documentation
License
MIT (license)
Dependencies
flutter, flutter_markdown, flutter_riverpod, markdown, url_launcher
