Skip to content

Latest commit

 

History

History
103 lines (67 loc) · 2.72 KB

MenuV1alpha1PublicApi.md

File metadata and controls

103 lines (67 loc) · 2.72 KB

halo_client.api.MenuV1alpha1PublicApi

Load the API package

import 'package:halo_client/api.dart';

All URIs are relative to http://localhost:8091

Method HTTP request Description
queryMenuByName GET /apis/api.halo.run/v1alpha1/menus/{name}
queryPrimaryMenu GET /apis/api.halo.run/v1alpha1/menus/-

queryMenuByName

MenuVo queryMenuByName(name)

Gets menu by name.

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getMenuV1alpha1PublicApi();
final String name = name_example; // String | Menu name

try {
    final response = api.queryMenuByName(name);
    print(response);
} catch on DioException (e) {
    print('Exception when calling MenuV1alpha1PublicApi->queryMenuByName: $e\n');
}

Parameters

Name Type Description Notes
name String Menu name

Return type

MenuVo

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

queryPrimaryMenu

MenuVo queryPrimaryMenu()

Gets primary menu.

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getMenuV1alpha1PublicApi();

try {
    final response = api.queryPrimaryMenu();
    print(response);
} catch on DioException (e) {
    print('Exception when calling MenuV1alpha1PublicApi->queryPrimaryMenu: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

MenuVo

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]