github.com/reverseOpenApi/back

Reverse OpenAPI

Generate an OpenAPI document with a simple web form.

Team

• Tan NGUYEN
• Clément HALLER
• Merith NDOLO
• Samuel BELOLO
• Filoupatir HANNA
• Issam EL MOUTII
• Marc PIERRON

Summary

• The project
  • Getting started
  • Folder structure
• Conventions
  • Commit conventions
  • Branch conventions
• Stack
  • Infrastructure
  • Api Client container
  • OpenAPI Service container
  • SQL Fixtures Service container
  • Functional test service container
  • GCP Pub/Sub Emulator container
  • Entity relationship diagram

Getting started

Clone and run the project via docker.

$ docker-compose up

Folder structure

TODO

Conventions

Commit conventions

Use Gitmoji to define the type of the commit. Rest of the commit message follow the Conventionnal Commits Specification.

:emoji type:[optional scope] <description>

[optional body]

[optional footer(s)]

Branch conventions

Manage branches using the GitFlow branching model.

<service-name>/<feature|release|hotfix|support>/<name>

Stack

Infrastructure

[insert infrastructure schema]

Api Client container

[localhost]
A Symfony API consumed by the front-end client.

OpenAPI Service container

[localhost:81]
A Symfony service that generates OpenAPI documents.

SQL Fixtures service container

[localhost:82]
A symfony service that generates SQL queries and fake data from OpenAPI schemas.

Functional test service container

[localhost:83]
A GO service that generates functional tests for OpenAPI schemas.

GCP Pub/Sub Emulator container

[localhost:8085]
The official GCP Pub/Sub Emulator used to communicate between the api client and services.

Database container

[localhost:3306]
A MySQL database that can be managed with PHPMyAdmin at localhost:8080 :

• username: root
• password: root

Entity relationship diagram