/requestPY

Primary LanguagePythonApache License 2.0Apache-2.0

aiqfome logo

requestPY

requestPY Uma estrutura para validar o json da solicitação/resposta e criar documentação para aplicativos mantidos pelos desenvolvedores do aplicativo mais ganancioso da internet !

Feito por VOID


Instalar com pip3

pip3 instalar requestPY

Init na pasta do projeto

requestPY --init

Será criada a pasta data_scructures_io e static.

No data_scructures_io, estão os arquivos json para testar a requisição. Exemplo

Estamos usando Cerberus para validar a estrutura. Portanto, se algum válido na resposta json for um nome, digite ou não envie. Ocorrerá uma exceção nos testes.

Na pasta static, estará o arquivo json para Swagger, com este arquivo você pode fazer qualquer pacote em qualquer idioma que você queira ler. Este swagger.json é gerado, então toda vez que você executar o comando requestPY -g na pasta este arquivo será atualizado.

O arquivo .requestPY.config

Este arquivo json é para configuração, então as pastas de nomes e outras coisas podem ser personalizáveis.

docs_url

com o comando requestPY --docs será ativado um servidor flask na porta 3000 e lerá o arquivo swagger, este valor é para o qual a url será executada. padrão: localhost:3000/docs

save_file_swagger

O arquivo de nome gerado para swagger. padrão: swagger.json

data_structures_folder

A pasta de nomes que são as estruturas de dados para solicitações. padrão: data_structures_io

pasta_testes

O nome da pasta que serão os testes. padrão: testes

####tests_before_cmd Às vezes, no projeto, queremos executar o comando/script antes de iniciar os testes, por exemplo, criar as tabelas no bd. Irá executar este comando antes de iniciar os testes.

####tests_between_cmd Este comando é para rodar entre testes, no tearDown, então após rodar um teste, isso é para um script ou migration que você quer rodar para limpar o bd por exemplo.