myMVC_module_OpenApi

mymvc_module_openapi

Exigences

• Linux
• php> = 8
  • Extension pdo
• mymvc 3.x
  • git clone --branch 3.x https://github.com/gueff/myMVC.git myMVC_3.x
  • Docs: https://mymvc.ueffing.net/
  • github: https://github.com/gueff/mymvc/tree/3.x

---

Installation

clone git

 cd /modules/ ;

git clone --branch 1.x 
https://github.com/gueff/myMVC_module_OpenApi.git 
OpenApi ; 

---

Usage

Valider contre le fichier openapi

 use OpenApi  Model  Validate ;

$ oDTValidateRequestResponse = Validate:: request (
    $ oDTRequestCurrent ,
    Config:: get_MVC_PUBLIC_PATH () . ' /openapi/api.yaml '
);

header ( ' Content-Type: application/json ' );
echo json_encode (Convert:: objectToArray ( $ oDTValidateRequestResponse ));

Valider contre l'URL OpenAPI

 use OpenApi  Model  Validate ;

// validate against openapi URL
$ oDTValidateRequestResponse = Validate:: request (
    $ oDTRequestCurrent ,
    ' https://example.com/api/openapi.yaml '
);

header ( ' Content-Type: application/json ' );
echo json_encode (Convert:: objectToArray ( $ oDTValidateRequestResponse ));

Création automatique des routes MYMVC à partir du fichier OpenAPI

Tous les itinéraires mènent à leur operationId donné, réglé dans OpenAPI

 OpenApi  Model Route:: autoCreateFromOpenApiFile (
    Config:: get_MVC_PUBLIC_PATH () . ' /openapi/api.yaml ' ,
    ' FooControllerApi '
);

Tous les routes mènent explicitement à Api::delegate()

 OpenApi  Model Route:: autoCreateFromOpenApiFile (
    Config:: get_MVC_PUBLIC_PATH () . ' /openapi/api.yaml ' ,
    ' FooControllerApi ' ,
    ' delegate '
);

---

Obtenir des journaux

Les journaux sont licenciés sur les événements.

Les événements disponibles sont:

• myMVC_module_OpenApi::sYamlSource

Écoutez l'événement et écrivez son contenu sur un fichier de journaux

 MVC Event:: bind ( ' myMVC_module_OpenApi::sYamlSource ' , function ( $ sContent ){
     MVC Log:: write ( $ sContent , ' openapi.log ' );
});