loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/samples/client/petstore/ruby-autoload/docs/UserApi.md
William Cheng c5a0374d2b
[Ruby] add useAutoload option to use autoload instead of require (#13153) 
* [Ruby] Use Ruby autoload to lower memory usage and load times

Fixes #12648

Requiring all models up front can be very expensive in both time and
memory if there are many models. In an example client with 6000 models,
this would consume nearly 400MB of memory and take about 7 seconds to
load. This is mostly unnecessary as most users of the client library
will only actually use a small percentage of the library.

The changes in this commit use Ruby's autoload capability to defer the
loading until the constant is actually used. In that same example client
with 6000 models, when initially requiring the library, the memory
usage dropped to ~20MB and loaded in 0.3 seconds. As the constants are
loaded on-demand, the memory would increase towards that 400MB ceiling,
but if only a few constants are actually used, then memory will never
actually hit that ceiling.

An additional side effect of using Ruby's autoload is that the order of
declaring the constants is not important, as Ruby will naturally load
them in the correct order when they are needed. Thus, this commit obviates
PR #9103 and fixes #4690.

* add option to use autoload in ruby client

* test ruby clients only

* add tests

* update samples

* Revert "test ruby clients only"

This reverts commit 0aaf71cd4cc5d266f824b261a4d312f07bd589e5.

* update doc

Co-authored-by: Jason Frey <fryguy9@gmail.com>
2022-08-11 12:45:13 +08:00

12 KiB
Raw Permalink Blame History

Petstore::UserApi

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

Method HTTP request Description
create_user POST /user Create user
create_users_with_array_input POST /user/createWithArray Creates list of users with given input array
create_users_with_list_input POST /user/createWithList Creates list of users with given input array
delete_user DELETE /user/{username} Delete user
get_user_by_name GET /user/{username} Get user by user name
login_user GET /user/login Logs user into the system
logout_user GET /user/logout Logs out current logged in user session
update_user PUT /user/{username} Updated user

create_user

create_user(user)

Create user

This can only be done by the logged in user.

Examples

require 'time'
require 'petstore'

api_instance = Petstore::UserApi.new
user = Petstore::User.new # User | Created user object

begin
  # Create user
  api_instance.create_user(user)
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->create_user: #{e}"
end

Using the create_user_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> create_user_with_http_info(user)

begin
  # Create user
  data, status_code, headers = api_instance.create_user_with_http_info(user)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->create_user_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
user User Created user object

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

create_users_with_array_input

create_users_with_array_input(user)

Creates list of users with given input array

Examples

require 'time'
require 'petstore'

api_instance = Petstore::UserApi.new
user = [Petstore::User.new] # Array<User> | List of user object

begin
  # Creates list of users with given input array
  api_instance.create_users_with_array_input(user)
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->create_users_with_array_input: #{e}"
end

Using the create_users_with_array_input_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> create_users_with_array_input_with_http_info(user)

begin
  # Creates list of users with given input array
  data, status_code, headers = api_instance.create_users_with_array_input_with_http_info(user)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->create_users_with_array_input_with_http_info: #{e}"
end

Parameters

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

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

create_users_with_list_input

create_users_with_list_input(user)

Creates list of users with given input array

Examples

require 'time'
require 'petstore'

api_instance = Petstore::UserApi.new
user = [Petstore::User.new] # Array<User> | List of user object

begin
  # Creates list of users with given input array
  api_instance.create_users_with_list_input(user)
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->create_users_with_list_input: #{e}"
end

Using the create_users_with_list_input_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> create_users_with_list_input_with_http_info(user)

begin
  # Creates list of users with given input array
  data, status_code, headers = api_instance.create_users_with_list_input_with_http_info(user)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->create_users_with_list_input_with_http_info: #{e}"
end

Parameters

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

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

delete_user

delete_user(username)

Delete user

This can only be done by the logged in user.

Examples

require 'time'
require 'petstore'

api_instance = Petstore::UserApi.new
username = 'username_example' # String | The name that needs to be deleted

begin
  # Delete user
  api_instance.delete_user(username)
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->delete_user: #{e}"
end

Using the delete_user_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_user_with_http_info(username)

begin
  # Delete user
  data, status_code, headers = api_instance.delete_user_with_http_info(username)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->delete_user_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
username String The name that needs to be deleted

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

get_user_by_name

get_user_by_name(username)

Get user by user name

Examples

require 'time'
require 'petstore'

api_instance = Petstore::UserApi.new
username = 'username_example' # String | The name that needs to be fetched. Use user1 for testing.

begin
  # Get user by user name
  result = api_instance.get_user_by_name(username)
  p result
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->get_user_by_name: #{e}"
end

Using the get_user_by_name_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_user_by_name_with_http_info(username)

begin
  # Get user by user name
  data, status_code, headers = api_instance.get_user_by_name_with_http_info(username)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <User>
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->get_user_by_name_with_http_info: #{e}"
end

Parameters

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

Return type

User

Authorization

No authorization required

HTTP request headers

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

login_user

String login_user(username, password)

Logs user into the system

Examples

require 'time'
require 'petstore'

api_instance = Petstore::UserApi.new
username = 'username_example' # String | The user name for login
password = 'password_example' # String | The password for login in clear text

begin
  # Logs user into the system
  result = api_instance.login_user(username, password)
  p result
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->login_user: #{e}"
end

Using the login_user_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(String, Integer, Hash)> login_user_with_http_info(username, password)

begin
  # Logs user into the system
  data, status_code, headers = api_instance.login_user_with_http_info(username, password)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => String
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->login_user_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
username String The user name for login
password String The password for login in clear text

Return type

String

Authorization

No authorization required

HTTP request headers

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

logout_user

logout_user

Logs out current logged in user session

Examples

require 'time'
require 'petstore'

api_instance = Petstore::UserApi.new

begin
  # Logs out current logged in user session
  api_instance.logout_user
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->logout_user: #{e}"
end

Using the logout_user_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> logout_user_with_http_info

begin
  # Logs out current logged in user session
  data, status_code, headers = api_instance.logout_user_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->logout_user_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

update_user

update_user(username, user)

Updated user

This can only be done by the logged in user.

Examples

require 'time'
require 'petstore'

api_instance = Petstore::UserApi.new
username = 'username_example' # String | name that need to be deleted
user = Petstore::User.new # User | Updated user object

begin
  # Updated user
  api_instance.update_user(username, user)
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->update_user: #{e}"
end

Using the update_user_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> update_user_with_http_info(username, user)

begin
  # Updated user
  data, status_code, headers = api_instance.update_user_with_http_info(username, user)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling UserApi->update_user_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
username String name that need to be deleted
user User Updated user object

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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