https://github.com/lagden/cep-koa-api
CEP GraphQL API
https://github.com/lagden/cep-koa-api
api cep cep-api docker graphql koa2 nodejs
Last synced: 4 months ago
JSON representation
CEP GraphQL API
- Host: GitHub
- URL: https://github.com/lagden/cep-koa-api
- Owner: lagden
- License: mit
- Created: 2015-05-12T07:46:31.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-02-04T12:46:32.000Z (over 2 years ago)
- Last Synced: 2024-12-30T03:32:14.588Z (5 months ago)
- Topics: api, cep, cep-api, docker, graphql, koa2, nodejs
- Language: Shell
- Homepage:
- Size: 2.29 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# CEP API
[![Docker Release][dockerelease-img]][dockerelease]
[![Node.js CI][ci-img]][ci]
[![Coverage Status][coveralls-img]][coveralls]
[![Snyk badge][snyk-img]][snyk]
[dockerelease-img]: https://img.shields.io/docker/v/lagden/cep_consulta/release-8.1.1
[dockerelease]: https://hub.docker.com/r/lagden/cep_consulta
[ci-img]: https://github.com/lagden/cep-koa-api/actions/workflows/nodejs.yml/badge.svg
[ci]: https://github.com/lagden/cep-koa-api/actions/workflows/nodejs.yml
[coveralls-img]: https://coveralls.io/repos/github/lagden/cep-koa-api/badge.svg?branch=master
[coveralls]: https://coveralls.io/github/lagden/cep-koa-api?branch=master
[snyk-img]: https://snyk.io/test/github/lagden/cep-koa-api/badge.svg
[snyk]: https://snyk.io/test/github/lagden/cep-koa-api
Encontre os endereços através do CEP.
---
Essa API está disponível Docker Hub: https://hub.docker.com/r/lagden/cep_consulta/
```shell
docker pull lagden/cep_consulta
```
⚠️ **Importante**
[Redis](https://redis.io/) é requirido.
## Via Docker
Exemplo utilizando `docker run`.
```
docker network create cep-network
docker run --network cep-network --name cep-redis -d redis:6-alpine
docker run --network cep-network --name cep -p 30008:5000 --env REDIS=cep-redis:6379 -d lagden/cep_consulta:latest
```
## Via Compose
Exemplo de um `yaml` para ser utilizando com o `docker compose` ou `docker stack deploy`.
```yaml
version: "3.7"
services:
redis:
image: redis:6-alpine
command: >
--appendonly yes
networks:
- net
volumes:
- db:/data
deploy:
restart_policy:
condition: on-failure
app:
image: docker.io/lagden/cep_consulta:latest
command: >
/bin/ash -c "
bin/helper/wait redis:6379;
node server
"
environment:
DEBUG_HIDE_DATE: 0
DEBUG_COLORS: 1
DEBUG_PREFIX: lagden_cep_consulta
DEBUG: lagden_cep_consulta:error
NODE_ENV: production
APP_ENV: production
APP_NS: lagden_cep_consulta
PORT: 30008
PORT_PUBLISHED: 30008
VERSION: release-8.1.1
#
CACHE_REDIS_NAMESPACE: lagden_cep_consulta
CACHE_REDIS_DB: 0
CLEAR_CACHE_FIRST_RUN: 0
#
REDIS: redis:6379
REDIS_HOST: redis
REDIS_PORT: 6379
ports:
- 30008:30008
networks:
- net
deploy:
resources:
limits:
cpus: '0.50'
memory: 200M
restart_policy:
condition: on-failure
networks:
net:
name: lagden_cep_consulta_net_production
volumes:
db:
name: lagden_cep_consulta_vol_production_db
```
## Uso
```shell
curl 'http://127.0.0.1:30008/gql' \
-H 'content-type: application/json' \
-d '{
"source": "query Consulta($cep: String!) { consulta(cep: $cep) { endereco, bairro, cidade, uf } }",
"variableValues": {"cep": "01311-000"},
"operationName": "Consulta"
}' --compressed
```
```json
{
"data": {
"consulta": {
"endereco": "Avenida Paulista",
"bairro": "Bela Vista",
"cidade": "São Paulo",
"uf": "SP"
}
}
}
```
## License
MIT © [Thiago Lagden](https://github.com/lagden)