Categorygithub.com/panda-crm/panda-api
modulepackage
0.0.0-20170917185818-f7e54d51fca7
Repository: https://github.com/panda-crm/panda-api.git
Documentation: pkg.go.dev

# README

PANDA-API

Build Status

ENDPOINTS

Todos os pedidos são servidos através de HTTPS. A versão atual é v1.

OBJETOS

Esses são todos os objetos oferecidos pela API no formato JSON.

CONFIGURAÇÕES

Banco de Dados

Nesse projeto é utilizado o ORM Gorm para fazer todos os relacionamentos do banco de dados. Por padrão o sistema está configurado para fazer AutoMigrate de todas as entidades. Para realizar a configuração de usuário, senha, host e nome do banco; sete as variaveis ambientes.

const(
    ENV_DB_DRIVER = "DB_DRIVER"
    ENV_DB_HOST = "DB_HOST"
    ENV_DB_NAME = "DB_NAME"
    ENV_DB_USER = "DB_USER"
    ENV_DB_PASSWORD = "DB_PASSWORD"
    ENV_DB_SSL_MODE = "DB_SSL_MODE"
    ENV_DB_MAX_CONNECTION = "DB_MAX_CONNECTION"
    ENV_DB_LOG_MODE = "DB_LOG_MODE"
)

Caso o sistema não encontre as variáveis ambientes, ele irá rodar localmente com essas configurações:

var(
    DB_DRIVER string = "postgres"
    DB_HOST string = "localhost"
    DB_NAME string = "panda"
    DB_USER string = "pandaapi"
    DB_PASSWORD string = "1234"
    DB_SSL_MODE string = "disable" // disable | require
    DB_MAX_CONNECTION int = 1
    DB_LOG_MODE bool = true
)

JWT Token Auth

Para fazer qualquer alteração no SECRET_KEY do token, sete a variável ambiente abaixo:

const ENV_JWT_SECRET_KEY = "JWT_SECRET_KEY" // default = panda

Porta API

A porta da API está setada para 8080. Para realizar alteração na porta, sete a seguinte variável ambiente.

const ENV_RUN_PORT = "PORT" // default = 8080

Integração de Logs com Bugsnag

Sistema é integrado com o Bugsnag para analise de logs e problemas. Para ativar a integração, basta configurar a seguinte variável ambiente:

const ENV_API_KEY_BUGSNAG = "API_KEY_BUGSNAG"

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

ENV_RUN_PORT variavel ambiente da porta de inicialização.

# Variables

RUN_PORT porta de inicialização padrão.