openapi-generator/samples/client/petstore/c

C API client for openapi_petstore

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:
• Generator version: 7.6.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.CLibcurlClientCodegen

Installation

You'll need the curl 7.58.0 package in order to build the API. To have code formatted nicely, you also need to have uncrustify version 0.67 or later.

Prerequisites

Install the curl 7.58.0 package with the following command on Linux.

sudo apt remove curl
wget http://curl.haxx.se/download/curl-7.58.0.tar.gz
tar -xvf curl-7.58.0.tar.gz
cd curl-7.58.0/
./configure
make
sudo make install

Install the uncrustify 0.67 package with the following command on Linux.

git clone https://github.com/uncrustify/uncrustify.git
cd uncrustify
mkdir build
cd build
cmake ..
make
sudo make install

Compile the sample:

This will compile the generated code and create a library in the build folder which has to be linked to the codes where API will be used.

mkdir build
cd build
// To install library to specific location, use following commands
cmake -DCMAKE_INSTALL_PREFIX=/pathtolocation ..
// for normal install use following command
cmake ..
make
sudo make install

How to use compiled library

Considering the test/source code which uses the API is written in main.c(respective api include is written and all objects necessary are defined and created)

To compile main.c(considering the file is present in build folder) use following command -L - location of the library(not required if cmake with normal installation is performed) -l library name

gcc main.c -L. -lopenapi_petstore -o main

Once compiled, you can run it with ./main

Note: You don't need to specify includes for models and include folder separately as they are path linked. You just have to import the api.h file in your code, the include linking will work.

Documentation for API Endpoints

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

Category	Method	HTTP request	Description
PetAPI	PetAPI_addPet	POST /pet	Add a new pet to the store
PetAPI	PetAPI_deletePet	DELETE /pet/{petId}	Deletes a pet
PetAPI	PetAPI_findPetsByStatus	GET /pet/findByStatus	Finds Pets by status
PetAPI	PetAPI_findPetsByTags	GET /pet/findByTags	Finds Pets by tags
PetAPI	PetAPI_getPetById	GET /pet/{petId}	Find pet by ID
PetAPI	PetAPI_updatePet	PUT /pet	Update an existing pet
PetAPI	PetAPI_updatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
PetAPI	PetAPI_uploadFile	POST /pet/{petId}/uploadImage	uploads an image
StoreAPI	StoreAPI_deleteOrder	DELETE /store/order/{orderId}	Delete purchase order by ID
StoreAPI	StoreAPI_getInventory	GET /store/inventory	Returns pet inventories by status
StoreAPI	StoreAPI_getOrderById	GET /store/order/{orderId}	Find purchase order by ID
StoreAPI	StoreAPI_placeOrder	POST /store/order	Place an order for a pet
UserAPI	UserAPI_createUser	POST /user	Create user
UserAPI	UserAPI_createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
UserAPI	UserAPI_createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
UserAPI	UserAPI_deleteUser	DELETE /user/{username}	Delete user
UserAPI	UserAPI_getUserByName	GET /user/{username}	Get user by user name
UserAPI	UserAPI_loginUser	GET /user/login	Logs user into the system
UserAPI	UserAPI_logoutUser	GET /user/logout	Logs out current logged in user session
UserAPI	UserAPI_testIntAndBool	GET /user/testIntAndBool	test integer and boolean query parameters in API
UserAPI	UserAPI_updateUser	PUT /user/{username}	Updated user

Documentation for Models

• MappedModel_t
• api_response_t
• category_t
• model_with_set_propertes_t
• order_t
• pet_t
• tag_t
• user_t

Documentation for Authorization

Authentication schemes defined for the API:

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

api_key

• Type: API key

• API key parameter name: api_key

• Location: HTTP header

Author