ApiHelper
O pacote @churchapps/apihelper oferece utilitários do lado do servidor para todas as APIs Express.js da ChurchApps. Ele inclui a classe base de controladores, a autenticação JWT, utilitários de banco de dados e integrações com a AWS, que todos os projetos de API utilizam.
Antes de começar
- Instale o Node.js e o Git -- veja Pré-requisitos
- Familiarize-se com a configuração e o fluxo de lançamento do espaço de trabalho de Pacotes
- Este pacote depende de
@churchapps/helpers(como dependência de par) e o reexporta
O que está incluído
- CustomBaseController -- classe base para controladores de API, construída sobre o
inversify-express-utils - Autenticação -- autenticação JWT por meio de
CustomAuthProvider,AuthenticatedUserePrincipal - Utilitários de banco de dados --
DB.query/DB.queryOnee a classePoolpara o gerenciamento de conexões MySQL, além deMySqlHelpereDBCreatorpara a configuração do esquema - Integrações com a AWS --
AwsHelperpara o armazenamento de arquivos no S3 e a leitura do SSM Parameter Store - E-mail --
EmailHelper, com suporte aos transportes SES e SMTP - Carregamento de configuração --
EnvironmentBaselê strings de conexão e segredos a partir de variáveis de ambiente ou do Parameter Store - Diversos --
EncryptionHelper,FileStorageHelper,LoggingHelper,BasePermissions,SlugHelper
Configuração para desenvolvimento local
Este pacote está no espaço de trabalho Packages, junto com as demais bibliotecas compartilhadas:
-
Clone o espaço de trabalho:
git clone https://github.com/ChurchApps/Packages.git -
Instale as dependências na raiz do espaço de trabalho:
cd Packages && yarn install -
Compile o projeto (transforma o TypeScript em
dist/):yarn workspace @churchapps/apihelper buildOu execute
yarn buildna raiz para compilar todos os pacotes na ordem de dependência.
Para testar alterações dentro de uma API que o consome, use um portal temporário do Yarn -- veja Desenvolvimento local com uma aplicação consumidora.
Publicação
As versões são publicadas com o changesets: execute yarn changeset na raiz do espaço de trabalho para cada alteração e, quando estiver pronto para lançar, execute yarn publish-all. Veja o Panorama das bibliotecas compartilhadas para o fluxo completo.
Este pacote é uma dependência de todas as APIs da ChurchApps -- a Api principal, a AskApi e a LessonsApi. Ao fazer alterações, teste-as localmente em uma API antes de publicar.
Artigos relacionados
- Helpers -- O pacote base de utilitários do qual este pacote depende
- Estrutura de módulos -- Como os controladores e o middleware de autenticação são usados nos módulos da API
- Configuração local da API -- Como configurar a API para desenvolvimento local