forked from loafle/openapi-generator-original
a7df4adcf5
* Add boost-uid to vcpkg isntall command. It's required. * Add instructions for building on visual studio 2017 * Add section to support vcpkg and visual studio * Undef U on windows to stop compiler error * Update pet store sample * Move undef U to apiclient-header * Slight change to address compiler warning
51 lines
1.7 KiB
Markdown
51 lines
1.7 KiB
Markdown
# C++ API client
|
|
|
|
This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
|
|
|
|
## Overview
|
|
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI spec](https://openapis.org) from a remote server, you can easily generate an API client.
|
|
|
|
- API version: 1.0.0
|
|
- Package version:
|
|
- Build package: org.openapitools.codegen.languages.CppRestSdkClientCodegen
|
|
|
|
- API namespace: org.openapitools.client.api
|
|
- Model namespace: org.openapitools.client.model
|
|
|
|
## Installation
|
|
|
|
### Prerequisites
|
|
|
|
Install [cpprestsdk](https://github.com/Microsoft/cpprestsdk).
|
|
|
|
- Windows: `vcpkg install cpprestsdk cpprestsdk:x64-windows boost-uuid boost-uuid:x64-windows`
|
|
- Mac: `brew install cpprestsdk`
|
|
- Linux: `sudo apt-get install libcpprest-dev`
|
|
|
|
### Build
|
|
|
|
```sh
|
|
cmake -DCPPREST_ROOT=/usr -DCMAKE_CXX_FLAGS="-I/usr/local/opt/openssl/include" -DCMAKE_MODULE_LINKER_FLAGS="-L/usr/local/opt/openssl/lib"
|
|
make
|
|
```
|
|
|
|
### Build on Windows with Visual Studio (VS2017)
|
|
|
|
- Right click on folder containing source code
|
|
- Select 'Open in visual studio'
|
|
- Once visual studio opens, CMake should show up in top menu bar.
|
|
- Select CMake > Build All.
|
|
|
|
*Note: If the CMake menu item doesn't show up in Visual Studio, CMake
|
|
for Visual Studio must be installed. In this case, open the 'Visual Studio
|
|
Installer' application. Select 'modify' Visual Studio 2017. Make sure
|
|
'Desktop Development with C++' is installed, and specifically that 'Visual
|
|
C++ tools for CMake' is selected in the 'Installation Details' section.
|
|
|
|
Also be sure to review the CMakeLists.txt file. Edits are likely required.*
|
|
|
|
## Author
|
|
|
|
|
|
|