gabrieldocs / api-typescript-express Goto Github PK

Para executar o projeto é necessário primeiramente iniciar o container docker com a imagem do MongoDB. Para isto pode-se fazer na raiz do projeto:

$ docker-compose -f mongo.yaml -d

Este comando irá executar o mongodb e o mongo-express, fornecendo um ambiente gráfico onde os documentos podem ser visualizados.

Em seguida deve-se mudar para a pasta app e executar o seguinte comando:

$ npm run dev

Como melhorar a documentação para iniciar o uso de Kubernets?

O padrão de documentação e comentários ainda não foi estabelecido, porém pretendo adotar o SWAGER para documentar a API.

Estou seguindo a convenção de utilizar nomes de rotas no plural:

/users
/applications
/apps

Métodos específicos como excluir ou atualizar recebem a seguinte estrutura:

/users/:id/update
/users/:id/delete
/apps/:id/update

Estou tentando seguir o HTTP, ainda falta revisar o funcionamento dos métodos patch e delete

Os testes ainda não foram implementados para esta API, em breve pretendo adicionar testes unitários e de integração em TypeScript.

A aplicação é capaz de conectar-se com uma base de dados MongoDB executado dentro de um container com Docker. Problema a relatar: quando a aplicação é executada fora de um container ainda há dificuldade em conectar com a base de dados instalada localmente.

Há a necessidade de implementar um breve manual acerca da execução em ambiente local e também como aplicação conteinerizada.