Ogólna dokumentacja platformy

[Baro-coder]

Opracować

1. Diagram struktury architektury platformy
2. Struktura katalogowa repozytorium
3. Wytyczne do komunikacji pomiędzy mikrousługami

[Baro-coder]

Ad. 1.

Diagram struktury architektury

[Baro-coder]

Ad. 2.

Struktura katalogowa repozytorium

.
├── assets                              /*!< obrazy, wykresy, diagramy */            
├── docs                                /*!< dokumentacja */                
└── software                            /*!< kod źródłowy aplikacji */       
    ├── services                        /*!< mikrousługi */    
    │   ├── api_gateway                 /*!< Usługa API_GATEWAY */    
    │   │   ├── Dockerfile                  /*!< skrypt budujący obraz Docker'a */    
    │   │   └── app                         /*!< kod źródłowy usługi */    
    │   ├── client                      /*!< Usługa aplikacji klienckiej */    
    │   │   ├── Dockerfile                  /*!< skrypt budujący obraz Docker'a */
    │   │   └── app                         /*!< kod źródłowy usługi */
    │   ├── db                          /*!< Usługa DB */
    │   │   ├── Dockerfile                  /*!< skrypt budujący obraz Docker'a */
    │   │   └── scripts                     /*!< skrypty inicjujące bazy danych */
    │   ├── db_driver                   /*!< Usługa DB_DRIVER */
    │   │   ├── Dockerfile                  /*!< skrypt budujący obraz Docker'a */
    │   │   └── app                         /*!< kod źródłowy usługi */
    │   ├── docker-compose.yml          /*!< skrypt agregujący obrazy Docker'a */
    │   ├── employee                    /*!< Usługa EMPLOYEE */
    │   │   ├── Dockerfile                  /*!< skrypt budujący obraz Docker'a*/
    │   │   └── app                         /*!< kod źródłowy usługi */
    │   ├── employer                    /*!< Usługa EMPLOYER */
    │   │   ├── Dockerfile                  /*!< skrypt budujący obraz Docker'a */
    │   │   └── app                         /*!< kod źródłowy usługi */
    │   └── identity                    /*!< Usługa IDENTITY */
    │       ├── Dockerfile                  /*!< skrypt budujący obraz Docker'a */
    │       └── app                        /*!< kod źródłowy usługi */
    ├── tools                       /*!< narzędzia i skrypty pomocnicze dla VM */
    └── vm                          /*!< maszyna wirtualna, konfiguracje VM */

[Baro-coder]

Ad. 3.

Wzory odpowiedzi HTTP

Odpowiedzi POZYTYWNE

Odpowiedź pozytywna powinna zawierać trzy pola:

1. code - Status odpowiedzi (duplikacja zwracanego statusu HTTP)
2. message - Słowny opis statusu odpowiedzi
3. data - Zwracana struktura danych

Przykład:

{
    "code" : 201,
    "message" : "Resource successfully created.",
    "data" : [
        "email" : "user@gmail.com"
        "username" : "user",
    ]
}

Odpowiedzi NEGATYWNE

Odpowiedzi negatywne powinny zawierać trzy pola:

1. code - Status odpowiedzi (duplikacja zwracanego statusu HTTP)
2. message - Słowny opis statusu odpowiedzi
3. error - Szczegółowy opis błędu

Przykład:

{
    "code" : 409,
    "message" : "Resource already exists."
    "error" : "This email address is already taken."
}