About CMake project structure for CppRestApi

Before getting into the tutorial, I will explain how to use CMake, cpprestsdk, and mysql-connector-cpp with CppRestApi.

With CMake, project management becomes easier by first determining the directory structure.

It will be easier to decide on the directory structure if you refer to the top-level CMakeLists.txt, which has a set format. Define each item in CMakeLists.txt as follows:

・Preamble

Set the project name and version in the top-level CMakeLists.txt.

・Project wide setup

Set variables to be used throughout the project. Set them in the top-level CMakeLists.txt.

・Dependencies

Find dependent packages. Packages in a general directory structure can be found using cmake functions. Set them in dependencies/CMakeLists.txt.

・Main build targets

Configure the build settings for the source program. Resolve the dependencies of each source. Set the dependency resolution in cmake/libs/DirectoryName.cmake. Set it in src/CMakeLists.txt. Place the program configuration file in the include/config directory. Set the setting to replace placeholders with cmake functions in include/CMakeLists.txt.

・Tests

Set up the build settings for the test program. Set dependency resolution to cmake/tests/DirectoryNameTest.cmake. Set it in tests/CMakeLists.txt.

・Packaging

Configure CPack. Set it in packaging/CMakeLists.txt.

Build with scripts/build.sh. The build result will be created in /CppRestApi/build. When building with the above project settings, the top-level CMakeLists.txt includes each subdirectory with the add_subdirectory function. Therefore, a directory containing each CMakeLists.txt will be created under the build folder. Since the CMake project dependencies are resolved in CMakeLists.txt, they can be included from other projects with the add_subdirectory function.