myMVC_module_OpenApi

mymvc_module_openapi

Requisitos

• Linux
• php> = 8
  • Extensão 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

---

Instalação

clone git

 cd /modules/ ;

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

---

Uso

Validar contra o arquivo 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 ));

Validar contra o Openapi URL

 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 ));

rotas MyMVC de criação automática do arquivo OpenApi

operationId

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

Todas as rotas levam explicitamente à Api::delegate()

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

---

Obtenha logs

Os registros são demitidos para eventos.

Os eventos disponíveis são:

• myMVC_module_OpenApi::sYamlSource

Ouça o evento e escreva seu conteúdo para um arquivo de log

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