api_guide 1.0.17

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

---

API Guide

Flutter package to generate API calls documentations like OpenAPI schema.

Screenshots 💻

About ❓

• API Guide is package to generate API calls documentations like OpenAPI schema. For example, Get, Post, Put, Delete or Options Http requests and responses.

API Integration Guide Features ✨

• Generative code model covers 30+ snippet code types with multiple servers.
• Possibility to copy sample code to the clipboard by clicking the button.
• Responsive design supports large, medium and small screens.
• Light and dark theme mode.
• Responsive and fast search tool with keystroke shortcuts.
• The beautiful introduction section can be modified as needed.
• The Infinite FAQ section can be modified with any number of questions and answers.
• Seamless scrollable sidebar.
• It appears clear by version and last update date.
• Optional Privacy Policy and Terms of Use API Integration Guide footer links.
• Optional SPDX Licence API Integration Guide footer link with supporting of 400+ SPDX Licence types.
• Optional variant to change the theme color supports 14 color distributions.
• Built in accordance with W3 Consortium and OpenAPI Schema recommendations.

Installation and Basic Usage ⏳

① First: Add to pubspec.yaml:

dependencies:
  api_guide: ^1.0.17

② Second: import it to your project:

import 'package:api_guide/api_guide.dart';

③ Finally add APIGuide().display() into your target web pages with required parameters.

Notes 📝

• Set the [debugShowCheckedModeBanner] value to [false] to hide the top debug red ribbon at the [MaterialApp].
• If you add the [APIGuide().display()] widget inside the [Scaffold] widget make sure to put it inside the body only without the [appBar], [drawer], [floatingActionButton], [bottomNavigationBar] or [bottomSheet] because it has the Scaffold with all needed attributes as full page screen widget.
• The preferred way to adding [APIGuide().display()] is inside the [build] method as return value directly of the [StatelessWidget].
• If you do not set the [termsLink] or [privacyLink] it is not appear.
• If you do not set the [themeColor] it is automatic take the [APIGuideThemeColor.indigo] swatch palette color.

Full Usage Example Code ✅

Here is a full usage example code:

// Developed by Eng. Mouaz M. Al-Shahmeh
import 'package:api_guide/api_guide.dart';
import 'package:flutter/material.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    // Create the main application widget
    return const MaterialApp(
      debugShowCheckedModeBanner: false,
      title: 'Flutter API Guide Example',
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatelessWidget {
  const MyHomePage({super.key});

  @override
  Widget build(BuildContext context) {
    // Define API Servers as needed
    List<APIServer> apiServers = [
      APIServer(
        urlHost: 'https://example.com',
      ),
    ];

    // Define API Items with all needed properties
    List<APIItem> apiItems = [
      // Define the first API item
      APIItem(
        // Define the request for the first API item
        request: const APIGuideRequest(
          method: HttpRequestMethod.GET,
          params: [],
          body: [],
        ),
        // Define the response for the first API item
        response: [
          const APIGuideResponse(
            statusCode: HttpResponseStatusCode.OK,
            headers: [],
            body: {
              "status": 200,
              "data": {
                "name": "Dash",
                "isFly": true,
              }
            },
          ),
        ],
        title: 'All Dashes',
        urlPath: '/dashes',
        description: 'All Dashes get example description.',
      ),
      // Define the second API item
      APIItem(
        // Define the request for the second API item
        request: const APIGuideRequest(
          method: HttpRequestMethod.POST,
          params: [],
          body: [
            APIGuideRequestBody(
              key: 'name',
              value: 'Dash',
              type: PropertyType.string,
              description: 'This is the name attribute.',
              isRequired: true,
            ),
            APIGuideRequestBody(
              key: 'isFly',
              value: true,
              type: PropertyType.boolean,
              description: 'This is the isFly attribute.',
              isRequired: true,
            ),
          ],
        ),
        // Define the response for the second API item
        response: [
          const APIGuideResponse(
            statusCode: HttpResponseStatusCode.OK,
            headers: [],
            body: {
              "status": 200,
              "data": {
                "message": "Data Stored Successfully.",
              }
            },
          ),
          const APIGuideResponse(
            statusCode: HttpResponseStatusCode.BadRequest,
            headers: [],
            body: {
              "status": 400,
              "data": {
                "message": "Error Data Not Stored!",
              }
            },
          ),
        ],
        title: 'Create',
        urlPath: '/create',
        description: 'Store Dash post example description.',
      ),
    ];

    // Define API FAQs items as needed
    List<APIGuideFAQ> apiFaqs = [
      APIGuideFAQ(
        question: 'Can Dash Fly?',
        answer: 'Yes, Dash can Fly.',
      ),
    ];

    // Use APIGuide package with display method and pass needed parameters
    return APIGuide().display(
      context: context,
      servers: apiServers,
      apiItems: apiItems,
      apiFaqs: apiFaqs,
      version: 1.0,
      latestUpdate: DateTime.parse('2023-10-10'),
      apiIntro: 'This is some introduction to API Guide.',
    );
  }
}

Thank you 🎉

Make sure to check out example project. If you find this package useful, star my GitHub repository.

Flutter plugin was developed by: Eng. Mouaz M. Al-Shahmeh