openapi-generator/samples/client/petstore/eiffel/README.md

Eiffel API client for swagger

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: " \

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.EiffelClientCodegen

Installation

Add the library into your Eiffel configuration file.

    "<library name="api_client" location="%PATH_TO_EIFFEL_SWAGGER_CLIENT%\api_client.ecf"/>"

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
FAKE_API	fake_outer_boolean_serialize	Post /fake/outer/boolean
FAKE_API	fake_outer_composite_serialize	Post /fake/outer/composite
FAKE_API	fake_outer_number_serialize	Post /fake/outer/number
FAKE_API	fake_outer_string_serialize	Post /fake/outer/string
FAKE_API	test_client_model	Patch /fake	To test "client" model
FAKE_API	test_endpoint_parameters	Post /fake	Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
FAKE_API	test_enum_parameters	Get /fake	To test enum parameters
FAKE_API	test_json_form_data	Get /fake/jsonFormData	test json serialization of form data
FAKE_CLASSNAME_TAGS123_API	test_classname	Patch /fake_classname_test	To test class name in snake case
PET_API	add_pet	Post /pet	Add a new pet to the store
PET_API	delete_pet	Delete /pet/{petId}	Deletes a pet
PET_API	find_pets_by_status	Get /pet/findByStatus	Finds Pets by status
PET_API	find_pets_by_tags	Get /pet/findByTags	Finds Pets by tags
PET_API	pet_by_id	Get /pet/{petId}	Find pet by ID
PET_API	update_pet	Put /pet	Update an existing pet
PET_API	update_pet_with_form	Post /pet/{petId}	Updates a pet in the store with form data
PET_API	upload_file	Post /pet/{petId}/uploadImage	uploads an image
STORE_API	delete_order	Delete /store/order/{order_id}	Delete purchase order by ID
STORE_API	inventory	Get /store/inventory	Returns pet inventories by status
STORE_API	order_by_id	Get /store/order/{order_id}	Find purchase order by ID
STORE_API	place_order	Post /store/order	Place an order for a pet
USER_API	create_user	Post /user	Create user
USER_API	create_users_with_array_input	Post /user/createWithArray	Creates list of users with given input array
USER_API	create_users_with_list_input	Post /user/createWithList	Creates list of users with given input array
USER_API	delete_user	Delete /user/{username}	Delete user
USER_API	login_user	Get /user/login	Logs user into the system
USER_API	logout_user	Get /user/logout	Logs out current logged in user session
USER_API	update_user	Put /user/{username}	Updated user
USER_API	user_by_name	Get /user/{username}	Get user by user name

Documentation For Models

• ADDITIONAL_PROPERTIES_CLASS
• ANIMAL
• ANIMAL_FARM
• API_RESPONSE
• ARRAY_OF_ARRAY_OF_NUMBER_ONLY
• ARRAY_OF_NUMBER_ONLY
• ARRAY_TEST
• CAPITALIZATION
• CATEGORY
• CLASS_MODEL
• CLIENT
• ENUM_ARRAYS
• ENUM_CLASS
• ENUM_TEST
• FORMAT_TEST
• HAS_ONLY_READ_ONLY
• MAP_TEST
• MIXED_PROPERTIES_AND_ADDITIONAL_PROPERTIES_CLASS
• MODEL_200_RESPONSE
• NAME
• NUMBER_ONLY
• ORDER
• OUTER_BOOLEAN
• OUTER_COMPOSITE
• OUTER_ENUM
• OUTER_NUMBER
• OUTER_STRING
• PET
• READ_ONLY_FIRST
• RETURN
• SPECIAL_MODEL_NAME
• TAG
• USER
• CAT
• DOG

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header

http_basic_test

• Type: HTTP basic authentication

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://petstore.swagger.io/api/oauth/dialog
• Scopes:
• write:pets: modify pets in your account
• read:pets: read your pets

Author

apiteam@swagger.io