README.md

gruene_api_client

If you want to publish a new version run

openapi-generator generate -i https://app.gruene.de/api-json -g dart-dio --additional-properties=pubName=gruene_api_client --additional-properties=pubLibrary=api_client --additional-properties=pubVersion=<version> & flutter pub run build_runner build

OpenAPI Endpoints

<a href="/api-json">OpenAPI Spec in JSON
<a href="/api-yaml">OpenAPI Spec in YAML

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

• API version: 0.1.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:
  gruene_api_client: 1.0.0

Github

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

dependencies:
  gruene_api_client:
    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:
  gruene_api_client:
    path: /path/to/gruene_api_client

Getting Started

Please follow the installation procedure and then run the following:

import 'package:gruene_api_client/gruene_api_client.dart';


final api = GrueneApiClient().getTagsApi();
final String type = type_example; // String | Only return tags of a certain type
final num page = 8.14; // num | 
final num limit = 8.14; // num | 

try {
    final response = await api.findTags(type, page, limit);
    print(response);
} catch on DioError (e) {
    print("Exception when calling TagsApi->findTags: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://app.gruene.de

Class	Method	HTTP request	Description
TagsApi	findTags	GET /v0/tags	List existing user skills
UsersApi	findUsers	GET /v0/users	Find users
UsersApi	getSelf	GET /v0/users/self	Get the authenticated user
UsersApi	getUser	GET /v0/users/{userId}	Get user by id

Documentation For Models

• FindTagsResponse
• FindUsersResponse
• PageInfo
• Tag
• User

Documentation For Authorization

bearer

• Type: HTTP basic authentication

api_key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

Author