openapi (EXPERIMENTAL)

Plane Pal API Documentation

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Generator version: 7.16.0
• Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

• Dart 2.15.0+ or Flutter 2.8.0+
• Dio 5.0.0+ (https://pub.dev/packages/dio)

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  openapi: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  openapi:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  openapi:
    path: /path/to/openapi

Getting Started

Please follow the installation procedure and then run the following:

import 'package:openapi/openapi.dart';


final api = Openapi().getAirlinesApi();
final String search = search_example; // String | The full(or a part of) name, ident or icao. Case Insensitive.

try {
    final response = await api.airlinesControllerGetAirlinesV1(search);
    print(response);
} catch on DioException (e) {
    print("Exception when calling AirlinesApi->airlinesControllerGetAirlinesV1: $e\n");
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AirlinesApi	airlinesControllerGetAirlinesV1	GET /v1/airlines	Get airlines
AirportsApi	airportsControllerGetAirportsV1	GET /v1/airports	Get all airports
AppApi	appControllerGetHelloV1	GET /v1
AuthenticationApi	authControllerGetCurrentUserV1	GET /v1/auth/@me	Get current user
AuthenticationApi	authControllerLoginV1	POST /v1/auth/login	Login
AuthenticationApi	authControllerRegisterV1	POST /v1/auth/register	Register

Documentation For Models

• AircraftEntity
• AircraftFlightEntity
• AircraftStatsEntity
• AircraftWithAge
• AirlineEntity
• AirlineInfo
• AirlineStatsEntity
• AirportEntity
• AirportInfo
• AirportStatsEntity
• AirportType
• CreateFlightBookingDTO
• FlighType
• FlightAwareDataEntity
• FlightBookingEntity
• FlightCandidateEntity
• FlightControllerDeleteFlightBookingV1200Response
• FlightDistanceEntity
• FlightDurationEntity

Documentation For Authorization

Authentication schemes defined for the API:

JWT-auth

• Type: HTTP Bearer Token authentication (JWT)

Author