https://github.com/martin-olivier/ziapi

The elected Zia API for {Epitech} promo 2024 (Paris and Marseille)
https://github.com/martin-olivier/ziapi

api cpp epitech http-server zia

Last synced: 18 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/martin-olivier/ziapi
• Owner: martin-olivier
• Created: 2022-01-15T10:40:53.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-07T20:41:07.000Z (over 2 years ago)
• Last Synced: 2024-10-13T08:05:58.335Z (about 1 month ago)
• Topics: api, cpp, epitech, http-server, zia
• Language: C++
• Homepage: https://ziapi.vercel.app/
• Size: 2.27 MB
• Stars: 25
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ZIAPI

![Banner](docs/assets/project_banner.png)

[![ZiAPI](https://img.shields.io/badge/ZiAPI-v5.0.0-blue.svg)](https://github.com/martin-olivier/ZiAPI/releases/tag/v5.0.0)

[![CPP Version](https://img.shields.io/badge/C++-17_and_above-darkgreen.svg)](https://isocpp.org/)

[![Discord](https://img.shields.io/discord/934852777136513075)](https://discord.gg/CzKv6dGXmf)

[![workflow](https://github.com/martin-olivier/ZiAPI/actions/workflows/CI.yml/badge.svg)](https://github.com/martin-olivier/ZiAPI/actions/workflows/CI.yml)

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**](https://ziapi.vercel.app)  

[**ZIAPI Official Discord**](https://discord.gg/CzKv6dGXmf)

## Documentation

You can find the documentation for the **ZIAPI** in our [documentation section](docs/README.md).

Here are the most useful doc pages for starting out:

- [Getting started](docs/general/GETTING_STARTED.md)

- [Install and build guide](docs/guides/INSTALL_AND_BUILD.md)

- [Module interfaces](docs/general/MODULES.md)

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

![Request / Response flow](docs/assets/request-response-diagram.png)

## Usage

### Fetch ZiAPI using CMake

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

```cmake

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`:

```cmake

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](https://discord.gg/CzKv6dGXmf)

## Authors

 - [Martin Olivier](https://github.com/martin-olivier)

 - [Diego Rojas](https://github.com/rojasdiegopro)

 - [Edouard Sengeissen](https://github.com/edouard-sn)

 - [Nicolas Allain](https://github.com/Nirasak)

 - [Romain Minguet](https://github.com/Romain-1)

 - [Allan Debeve](https://github.com/Gfaim)