loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-05-13 21:20:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
openapi-generator-original/samples/client/petstore/swift5/asyncAwaitLibrary/README.md
Beppe Catanese 68b944e6e6
Preserve order of securitySchemes (#14536) 
* Remove alphabetical sort

* Update integration testing expectations

* Regenerate files
2023-02-10 22:20:19 +08:00

7.2 KiB
Raw Permalink Blame History

Swift5 API client for PetstoreClient

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 OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version:
  • Build package: org.openapitools.codegen.languages.Swift5ClientCodegen

Installation

Carthage

Run carthage update

CocoaPods

Run pod install

Documentation for API Endpoints

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

Class Method HTTP request Description
AnotherFakeAPI call123testSpecialTags PATCH /another-fake/dummy To test special tags
FakeAPI fakeOuterBooleanSerialize POST /fake/outer/boolean
FakeAPI fakeOuterCompositeSerialize POST /fake/outer/composite
FakeAPI fakeOuterNumberSerialize POST /fake/outer/number
FakeAPI fakeOuterStringSerialize POST /fake/outer/string
FakeAPI testBodyWithFileSchema PUT /fake/body-with-file-schema
FakeAPI testBodyWithQueryParams PUT /fake/body-with-query-params
FakeAPI testClientModel PATCH /fake To test "client" model
FakeAPI testEndpointParameters POST /fake Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
FakeAPI testEnumParameters GET /fake To test enum parameters
FakeAPI testGroupParameters DELETE /fake Fake endpoint to test group parameters (optional)
FakeAPI testInlineAdditionalProperties POST /fake/inline-additionalProperties test inline additionalProperties
FakeAPI testJsonFormData GET /fake/jsonFormData test json serialization of form data
FakeClassnameTags123API testClassname PATCH /fake_classname_test To test class name in snake case
PetAPI addPet POST /pet Add a new pet to the store
PetAPI deletePet DELETE /pet/{petId} Deletes a pet
PetAPI findPetsByStatus GET /pet/findByStatus Finds Pets by status
PetAPI findPetsByTags GET /pet/findByTags Finds Pets by tags
PetAPI getPetById GET /pet/{petId} Find pet by ID
PetAPI updatePet PUT /pet Update an existing pet
PetAPI updatePetWithForm POST /pet/{petId} Updates a pet in the store with form data
PetAPI uploadFile POST /pet/{petId}/uploadImage uploads an image
PetAPI uploadFileWithRequiredFile POST /fake/{petId}/uploadImageWithRequiredFile uploads an image (required)
StoreAPI deleteOrder DELETE /store/order/{order_id} Delete purchase order by ID
StoreAPI getInventory GET /store/inventory Returns pet inventories by status
StoreAPI getOrderById GET /store/order/{order_id} Find purchase order by ID
StoreAPI placeOrder POST /store/order Place an order for a pet
UserAPI createUser POST /user Create user
UserAPI createUsersWithArrayInput POST /user/createWithArray Creates list of users with given input array
UserAPI createUsersWithListInput POST /user/createWithList Creates list of users with given input array
UserAPI deleteUser DELETE /user/{username} Delete user
UserAPI getUserByName GET /user/{username} Get user by user name
UserAPI loginUser GET /user/login Logs user into the system
UserAPI logoutUser GET /user/logout Logs out current logged in user session
UserAPI updateUser PUT /user/{username} Updated user

Documentation For Models

Documentation For Authorization

petstore_auth

api_key

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

api_key_query

  • Type: API key
  • API key parameter name: api_key_query
  • Location: URL query string

http_basic_test

  • Type: HTTP basic authentication

Author