api_guide
API Guide is package to generate API calls documentations like OpenAPI schema.
1.1.8
138 downloads/mo
#1702 most downloaded on pub.dev
Eng-Mouaz-M-AlShahmeh/api_guide
What this package is like to depend on
Last release 2 years ago
no release in 18 months
Release timing varies
gaps range from 8 days to 3 months
Nearly every release is documented
notes for 26 of 26 stable releases
Nothing withdrawn
no release was ever pulled
3 years old
26 releases · first in 2023
0 releases in the last 12 months
see the full history below
Release timeline
26 releases · Oct 2023 to May 2024
2024
2025
2026
Releases
latest 26-
1.1.815 May 2024Release notes
Open source →- Update MaterialStateProperty to WidgetStateProperty in (close_dialog_btn, sample_code_btn, server_btn, search).
- Update background to surfaceContainer in markdown_widget.
- Update onBackground to onSurfaceVariant in markdown_widget.
- Update example/web directory to support new service_worker features.
- Update url_launcher dependency in pubspec.yaml with version 6.2.6.
- Update flutter_riverpod dependency in pubspec.yaml with version 2.5.1.
- Update flutter_markdown dependency in pubspec.yaml with version 0.7.1.
- Update markdown dependency in pubspec.yaml with version 7.2.2.
-
1.1.724 Feb 2024Release notes
Open source →- Update to the new HardwareKeyboard functionality.
- Remove provider dependency.
- Add flutter_riverpod dependency in pubspec.yaml with version 2.4.10.
- Update flutter_markdown dependency to 0.6.20+2.
- Update markdown dependency to 7.2.1.
- Update url_launcher dependency to 6.2.5.
- Change the state management way from provider to riverpod in all library files.
- Update the library documentation.
-
1.1.613 Feb 2024 -
1.1.513 Feb 2024 -
1.1.428 Dec 2023Release notes
Open source →- Add markdown dependency.
- Fix Emoji issue.
- Fix markdown colorScheme.
- Add markdown code style.
-
1.1.327 Dec 2023Release notes
Open source →- Import flutter_markdown package with the version of ^0.6.18+2.
- Add markdown_widget helper to add markdown functionality.
- Add at Constants class (size500, size600, size800, size1000, size1500, size2500, size4000, size5000, size8000 and size10000) attributes.
- Add at Constants class the markdownTextStyle and markdownTextStyleBodyMedium from type of TextStyle and markdownTextTheme from type of TextTheme.
- Add the markdown functionality at (Introduction section, API items' description and FAQ answers).
-
1.1.206 Dec 2023Release notes
Open source →- Fix the Found no Flutter in your PATH. Could not determine the current Flutter version.
-
1.1.124 Nov 2023Release notes
Open source →- Fix add function by making params as not immutable.
- Update example code.
-
1.1.024 Nov 2023Release notes
Open source →- Remove unnecessary lints dependencies.
- Update example code.
- Make APIServer class constructor as const.
- Add SecuritySchemeType enum which supports common 19 standard types.
- Add APISecurityScheme domain class.
- Add isSecurityItem bool attribute to APIGuideParam to check functionality of security schemes.
- Update the updateAPIItemAndKeys application function to make isSecurityItem value not affecting the left side api items.
- Add updateAPIItemWithSecurity application function.
- Enhance the appearance of the api item right section.
- Add Security section at the right of the api item.
- Add hint if the security is optional at the api item.
- Update faq item is expanded function.
- Add security_item presentation function.
-
1.0.1718 Nov 2023Release notes
Open source →- Remove urlHost attribute from display functions from interface, implementation and main screen.
- Add APIServer domain class with urlHost String and optional title String.
- Pass new List of the APIServer attribute instead of urlHost.
- Update example code by updating servers attribute.
-
1.0.1618 Nov 2023Release notes
Open source →- Fix empty values for introduction, api items and faq sections at body and navigators.
- Fix empty values at search dialog.
- Fix Params items responsiveness.
- Add isDeprecated and isInternal bool attributes to the APIItem domain class.
- Add optional warning deprecated and info internal icons at the api item header with tooltip on hover.
-
1.0.1517 Nov 2023 -
1.0.1417 Nov 2023 -
1.0.1317 Nov 2023 -
1.0.1217 Nov 2023Release notes
Open source →- Fix designs at api card header, api card sample code header, api card params and body request, and footer links.
- Fix search result item fixed length of item description.
- Fix search dialog results scrolling.
- Update provider package to the version 6.1.1.
- Update flutter_lints to the version 3.0.1.
-
1.0.1113 Nov 2023Release notes
Open source →- Enhance version shape with fixed one decimal after comma.
- Enhance app bar shape at large screens.
- Enhance Navigator shape with optional contact email footer.
- Fix navigation to the same path but different http methods.
- Add SPDXLicenceType enums which support 400+ types.
- Add SPDX Licence Type optional footer link.
- Add Contact optional footer link.
- Add sendEmail helper function.
- Add Contact optional footer email.
-
1.0.1011 Nov 2023Release notes
Open source →- Update param domain class with needed attributes.
- Add ParameterType enum.
- Update sample code helper classes.
- Remove unnecessary headers from request class and merge with params.
- Make SampleCodePureTypes class as @immutable class.
- Update presentation of request api item details by params.
- Fix Closure and Obj-C request body sample code attributes.
- Add Query Params to sample code.
- Add Path Params dynamically to API Item header card path URL.
- Add Path Params to sample code.
- Update example code.
-
1.0.909 Nov 2023Release notes
Open source →- Enhance responsiveness at small screens.
- Update control search icon shortcut on windows platform.
- Remove unnecessary widgets from FAQs section and search dialog.
- Handle Esc key when close sample code dialog.
- Add @immutable annotation to proper domain and constant classes.
-
1.0.808 Nov 2023Release notes
Open source →- Fix Privacy and Terms link clicks.
- Enhance sample code button appearance.
- Enhance performance issues.
- Add optional theme color swatches from 14 color pallets.
- Import provider with version 6.0.5 package and enhance state management.
- Add explanatory comments.
-
1.0.703 Nov 2023Release notes
Open source →- Add explanatory comments.
- Fix Windows Ctrl key listener.
- Make all texts as a selectable.
-
1.0.603 Nov 2023Release notes
Open source →- Fix the API Guide header theme switch.
- Fix the return back from the main API Guide widget by wrapping with WillPopScope .
-
1.0.503 Nov 2023Release notes
Open source →- Fix sample code snippets to expand to the width.
- Fix API Item header at small screens.
- Fix FAQs title at small screens.
- Lightening the background color of the sample code.
- Fix responses to expand to the width.
- Reduce navigation functions to one and call everywhere.
- Add responsive search widget to search the API integration guide.
- Update example code by updating const positions.
- Update APIItem class model by adding isHovered attribute.
- Add explanatory comments.
-
1.0.430 Oct 2023Release notes
Open source →- Import url_launcher with version 6.2.1 package.
- Add Privacy & Policy and Terms of Use optional footer links.
-
1.0.327 Oct 2023 -
1.0.220 Oct 2023Release notes
Open source →- Justify Introduction text.
- Justify FAQs answer text.
- Update MyHomePage at example by new super key way.
- Update example flutter_lints to 3.0.0
- Update library flutter_lints to 3.0.0
- Update lints to 3.0.0
- Remove unused cupertino_icons at example pubspec.yaml
-
1.0.119 Oct 2023