ZiAPI Save

The elected Zia API for {Epitech} promo 2024 (Paris and Marseille)

Project README

ZIAPI

Banner

ZiAPI CPP Version Discord workflow

Welcome to the ZIAPI repository which contains the interfaces and concrete implementations that make up our Epitech Zia project API proposal.

ZIAPI was elected as the city-wide API for the Paris and Marseille Regions in 2022.

ZIAPI Official Website
ZIAPI Official Discord

Documentation

You can find the documentation for the ZIAPI in our documentation section.

Here are the most useful doc pages for starting out:

Here is a quick overview of how the request / response cycle is handled with the ZIAPI.

Request / Response flow

Usage

Fetch ZiAPI using CMake

Add the following content to your CMakeLists to fetch the API and include its header files in your project:

include(ExternalProject)

ExternalProject_Add(
    ziapi
    GIT_REPOSITORY  https://github.com/martin-olivier/ZiAPI.git
    GIT_TAG         v5.0.0
    INSTALL_COMMAND ""
    TEST_COMMAND    ""
)

add_dependencies(zia ziapi)
ExternalProject_Get_Property(ziapi SOURCE_DIR)
include_directories(${SOURCE_DIR}/include)

:bulb: Don't forget to link with libdl on unix if you use dylib:

if(UNIX)
    target_link_libraries(zia PRIVATE dl)
endif()

Contact

Feel free to submit any issues on our GitHub repository or ask questions on our Discord

Authors

Open Source Agenda is not affiliated with "ZiAPI" Project. README Source: martin-olivier/ZiAPI
Stars
25
Open Issues
2
Last Commit
2 years ago

Open Source Agenda Badge

Open Source Agenda Rating