loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/samples/client/petstore/dart2/openapi/docs/UserApi.md
Paul Mundt 4b0fc3013f [dart2] Fix up test code generation, double deserialization, 'new' keyword deprecation (#3576) 
* dart2: Use the correct classname in test generation

At present test generation has a stray hard-coded reference to the pet
store Pet() class, which should reflect the actual classname under test.

* dart2: Call toDouble() in generated code for double types

At present the generated code does not correctly handle transitioning
to double when dealing with non-integer types in JSON deserialization.
This ends up with dart raising an unhandled type mismatch exception:

Unhandled exception: type 'int' is not a subtype of type 'double' where
...

Using the .toDouble() conversion when a double type is expected fixes
this up by making the typing explicit.

* dart2: Drop use of deprecated 'new' keyword in generated code

The use of the 'new' keyword in dart2 is deprecated and should be
avoided, as per the official guidance of the dart2 authors:

https://dart.dev/guides/language/effective-dart/usage#dont-use-new

* dart2: Regenerate samples for mustache template changes
2019-08-09 00:15:45 +08:00

8.6 KiB
Raw Blame History

openapi.api.UserApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to http://petstore.swagger.io/v2

Method HTTP request Description
createUser POST /user Create user
createUsersWithArrayInput POST /user/createWithArray Creates list of users with given input array
createUsersWithListInput POST /user/createWithList Creates list of users with given input array
deleteUser DELETE /user/{username} Delete user
getUserByName GET /user/{username} Get user by user name
loginUser GET /user/login Logs user into the system
logoutUser GET /user/logout Logs out current logged in user session
updateUser PUT /user/{username} Updated user

createUser

createUser(body)

Create user

This can only be done by the logged in user.

Example

import 'package:openapi/api.dart';

var api_instance = UserApi();
var body = User(); // User | Created user object

try { 
    api_instance.createUser(body);
} catch (e) {
    print("Exception when calling UserApi->createUser: $e\n");
}

Parameters

Name Type Description Notes
body User Created user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

createUsersWithArrayInput

createUsersWithArrayInput(body)

Creates list of users with given input array

Example

import 'package:openapi/api.dart';

var api_instance = UserApi();
var body = [List&lt;User&gt;()]; // List<User> | List of user object

try { 
    api_instance.createUsersWithArrayInput(body);
} catch (e) {
    print("Exception when calling UserApi->createUsersWithArrayInput: $e\n");
}

Parameters

Name Type Description Notes
body List<User> List of user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

createUsersWithListInput

createUsersWithListInput(body)

Creates list of users with given input array

Example

import 'package:openapi/api.dart';

var api_instance = UserApi();
var body = [List&lt;User&gt;()]; // List<User> | List of user object

try { 
    api_instance.createUsersWithListInput(body);
} catch (e) {
    print("Exception when calling UserApi->createUsersWithListInput: $e\n");
}

Parameters

Name Type Description Notes
body List<User> List of user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

deleteUser

deleteUser(username)

Delete user

This can only be done by the logged in user.

Example

import 'package:openapi/api.dart';

var api_instance = UserApi();
var username = username_example; // String | The name that needs to be deleted

try { 
    api_instance.deleteUser(username);
} catch (e) {
    print("Exception when calling UserApi->deleteUser: $e\n");
}

Parameters

Name Type Description Notes
username String The name that needs to be deleted [default to null]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getUserByName

User getUserByName(username)

Get user by user name

Example

import 'package:openapi/api.dart';

var api_instance = UserApi();
var username = username_example; // String | The name that needs to be fetched. Use user1 for testing.

try { 
    var result = api_instance.getUserByName(username);
    print(result);
} catch (e) {
    print("Exception when calling UserApi->getUserByName: $e\n");
}

Parameters

Name Type Description Notes
username String The name that needs to be fetched. Use user1 for testing. [default to null]

Return type

User

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

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

loginUser

String loginUser(username, password)

Logs user into the system

Example

import 'package:openapi/api.dart';

var api_instance = UserApi();
var username = username_example; // String | The user name for login
var password = password_example; // String | The password for login in clear text

try { 
    var result = api_instance.loginUser(username, password);
    print(result);
} catch (e) {
    print("Exception when calling UserApi->loginUser: $e\n");
}

Parameters

Name Type Description Notes
username String The user name for login [default to null]
password String The password for login in clear text [default to null]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

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

logoutUser

logoutUser()

Logs out current logged in user session

Example

import 'package:openapi/api.dart';

var api_instance = UserApi();

try { 
    api_instance.logoutUser();
} catch (e) {
    print("Exception when calling UserApi->logoutUser: $e\n");
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

updateUser

updateUser(username, body)

Updated user

This can only be done by the logged in user.

Example

import 'package:openapi/api.dart';

var api_instance = UserApi();
var username = username_example; // String | name that need to be deleted
var body = User(); // User | Updated user object

try { 
    api_instance.updateUser(username, body);
} catch (e) {
    print("Exception when calling UserApi->updateUser: $e\n");
}

Parameters

Name Type Description Notes
username String name that need to be deleted [default to null]
body User Updated user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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