novawebmobi/usersapi Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

Users-Api

API direcionada ao controle de Usuários para os projetos da NovaWeb

Os Endpoints da API atualmente podem ser acessados via requisições RESTful da seguinte forma:

• HTTP_METHOD: GET POST PUT DELETE...
• PROTOCOL: HTTP HTTPS
• URI: usersapi.digitalingresso.dev.novaweb.mobi
• VERSION: v1
• ENDPOINT: users

PROTOCOL://URI/VERSION/ENDPOINT

Exemplo:

[***]

Primeiros Passos

Para facilitar o uso da API, é possível no momento acessar a Documentação Users-Api que contém todos os seus endpoints.

Veja as notas de deploy para instruções de como fazer o deploy do sistema para produção.

Pré requisitos

• Faça o download da última versão .NET Core SDK .NET Core 3.1 SDK
• Saiba mais sobre .NET Core

C
dotnet --version

Instalando

Para configurar o ambiente de desenvolvimento é necessário instalar os seguintes pacotes:

• Entity Framework Core para modelagem de objetos (EF Core)
• ASP.NET Core base API
• Flunt Notification Pattern
• Pomelo Entity Framework Core para suporte ao MySQL com EF Core 3.0+
• Swashbuckle para ocumentação dos endpoints

C
dotnet add package Flunt
dotnet add package Microsoft.AspNetCore.Authentication
dotnet add package Microsoft.AspNetCore.Authentication.JwtBearer
dotnet add package Microsoft.EntityFrameworkCore
dotnet add package Microsoft.EntityFrameworkCore.Tools
dotnet add package Microsoft.EntityFrameworkCore.Relational
dotnet add package Microsoft.Extensions.Configuration
dotnet add package Pomelo.EntityFrameworkCore.MySql
dotnet add package Swashbuckle.AspNetCore

Alternativamente, é possível restaurar todos os pacotes citados acima com o seguinte comando:

C
dotnet restore

Rodando os testes

Os teste podem ser executados usando

C
dotnet test Users-Api.sln

Os testes feitos são básicamente testes unitários e estáticos. Usando a metodologia Red Green Refactor

Deploy

As instruções de deploy abaixo assumem que você possui uma instância MySQL no CloudSQL da GCP e um cluster GKE com o Ambassador instalado.

Utilizaremos um namespace no Cluster para criar um "sub-Cluster". Namespaces são separações lógicas do cluster, o equivalente a uma VLAN. Você pode criar o seu namespace com o comando abaixo:

kubectl create namespace <NAMESPACE>

Em seguida, adicionaremos as credenciais do Docker Hub para garantir que o pull da imagem será autorizado. Para isso, utilize o comando abaixo:

kubectl create secret -n <NAMESPACE> docker-registry novaweb-secrets --docker-username=<USERNAME> --docker-password=<PASSWD> --docker-email=<EMAIL>

Feito isso, é necessário criar os deploy secrets de sua instância, que vão centralizar todos os parâmetros configuráveis da aplicação. O arquivodeploysecrets-template.txt é um template com todas as keys que devem ser preenchidas. Preencha-o e salve-o em um arquivo chamado deploysecrets.yaml. Atenção: você precisa especificar o namespace onde seu deploy será realizado neste arquivo. OBS: Caso você esteja utilizando mais de uma api da NovaWeb, crie um arquivo deploysecrets único que contenha todos os secrets necessários às API's que serão instanciadas. Caso contrário, ao subir um novo deploysecrets, o antigo será sobrescrito. Abaixo temos uma tabela com uma descrição das variáveis necessárias para esta API.

// TODO tabela

Depois de preencher o arquivo, aplique o arquivo no cluster com o comando abaixo:

kubectl apply -f deploysecrets.yaml

Em seguida, é necessário criar uma conta de serviço para o proxy do CloudSQL, para isso, utilize os comandos abaixo ou siga o tutorial desta página.

gcloud iam service-accounts keys create ~/key.json --iam-account <NOME_DA_CONTA>@project-id.iam.gserviceaccount.com
kubectl create secret generic sa-secret --from-file=service_account.json=~/key.json

Será necessário ativar o acesso ao CloudSQL para essa conta por meio do console de IAM.

Agora, você pode fazer o deploy da instância da API. Para isso, preencha o arquivo template.txt com os dados necessários e salve-o em um arquivo chamado deployment.yaml. Lembre-se de adicionar o namespace correto. Em seguida aplique o deployment com o seguinte comando:

kubectl apply -f deployment.yaml

Você pode conferir o status do deploy com o comando abaixo, que terá uma saída como a de exemplo:

kubectl get all -n <NAMESPACE>
>
NAME                               READY   STATUS    RESTARTS   AGE
pod/usersapi-694c7f5c9d-4x6n9      2/2     Running   0          15m

NAME                  TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)     AGE
service/usersapi      ClusterIP   10.0.xx.xx   <none>        20000/TCP   78m

NAME                          READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/usersapi      1/1     1            1           78m

NAME                                     DESIRED   CURRENT   READY   AGE
replicaset.apps/usersapi-694c7f5c9d      1         1         1       33m

NAME                                              REFERENCE                TARGETS         MINPODS   MAXPODS   REPLICAS   AGE
horizontalpodautoscaler.autoscaling/usersapi      Deployment/usersapi      <unknown>/90m   1         3         1          78m

Para habilitar o acesso externo, é necessário configurar o mapeamento do ambassador. Para isso, preencha o arquivo mapping-template.txt com o domínio configurado em seu DNS(que deve apontar para o IP externo do Load*** do Ambassador) e salve-o em mapping.yaml. Em seguida, aplique o arquivo com o comando abaixo:

kubectl apply -f mapping.yaml

Contribuindo

Por favor leia CONTRIBUTING.md para detalhes do nosso código de conduta e do processo de submissão de PR's para nós.

Versionamento

Usamos SemVer para versionamento. Para versões disponíveis, veja as tags nesse repositório.

Autores

• Fábio Trevizolo - Desenvolvedor - FabioTS

Veja também a lista de contribuidores que participaram nesse projeto.

* Modelo README foi adaptado pelos colaboradores do projeto

Licença

Esse projeto está licenciado sob uma licença do MIT - veja o arquivo LICENSE.md para detalhes

Agradecimentos

• Billie Thompson - Modelo README* - PurpleBooth
• Mateus Berardo - Tradução do modelo README para português* - MatTerra