{"id":15069048,"url":"https://github.com/carlosfernandoxavier/address-api","last_synced_at":"2026-02-13T05:04:19.981Z","repository":{"id":174261519,"uuid":"651979793","full_name":"CarlosFernandoXavier/address-api","owner":"CarlosFernandoXavier","description":"This repository contains an implementation that looks up an address, using the zip code provided by the user.","archived":false,"fork":false,"pushed_at":"2023-10-16T16:39:21.000Z","size":98,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-16T09:14:45.525Z","etag":null,"topics":["docker","hexagonal-architecture","java-11","multimodule-microservice","rest-api","springboot","swagger-ui"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CarlosFernandoXavier.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-10T17:30:32.000Z","updated_at":"2023-06-11T02:31:10.000Z","dependencies_parsed_at":"2024-11-22T08:45:55.173Z","dependency_job_id":null,"html_url":"https://github.com/CarlosFernandoXavier/address-api","commit_stats":null,"previous_names":["carlosfernandoxavier/address-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/CarlosFernandoXavier/address-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarlosFernandoXavier%2Faddress-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarlosFernandoXavier%2Faddress-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarlosFernandoXavier%2Faddress-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarlosFernandoXavier%2Faddress-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CarlosFernandoXavier","download_url":"https://codeload.github.com/CarlosFernandoXavier/address-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarlosFernandoXavier%2Faddress-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274046000,"owners_count":25212982,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-07T02:00:09.463Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","hexagonal-architecture","java-11","multimodule-microservice","rest-api","springboot","swagger-ui"],"created_at":"2024-09-25T01:40:10.962Z","updated_at":"2026-02-13T05:04:19.941Z","avatar_url":"https://github.com/CarlosFernandoXavier.png","language":"Java","readme":"## Objective: ##\n\nGet address by zipcode, by searching the viacep API\n\n\n## Running application: ##\nThere are four ways to execute this project:\n- Codespace: idea online from github which you don't need install anything;\n- Docker;\n- Favorite IDE local;\n- Jar;\n\n## Running project by codespace: ##\n\n### Step 1: ###\n\nhttps://github.com/CarlosFernandoXavier/address-api/assets/21314576/c6d08783-8dbd-48a6-adb2-f76d9cc14eb1\n\n### Step 2: ###\nhttps://github.com/CarlosFernandoXavier/address-api/assets/21314576/066a85d8-93de-4f4c-bd3b-75a1c5dde304\n\n\n## Running by Docker ##\n\n### Requirements to run by docker: ###\n\n    - Maven;\n    - Docker;\n    \n### Steps to run the program by docker:\n\n    - Clone the project: https://github.com/CarlosFernandoXavier/address-api.git;\n    - Open the terminal at the root of project;\n      - Execute the command: mvn clean package\n      - Execute the command: docker build -t address . \n      - Execute the command: docker run -p 8080:8080 address\n   \n\n## Running by your favorie IDE: \n\n### Requirements to run by IDE:\n\n    - Java 11;\n    - IDE (suggested intellij)\n    - Lombok;\n    - Maven;\n    - Enable annotation processers from your IDE;\n    \n      \n### Steps to run the program by IDE:\n\n    - Clone the project: https://github.com/CarlosFernandoXavier/address-api.git;\n    - Open the project in your IDE;\n    - Execute the command: mvn clean install;\n    - Execute the AddressApiApplication class;\n    - Open Postman;\n        - Import the curl;\n        - Execute the request;\n    \n\n## Running by .jar\n\n### Requirements to run by .jar:\n\n    - Java 11;\n    - Maven;\n\n      \n### Steps to run the program by .jar:\n\n    - Clone the project: https://github.com/CarlosFernandoXavier/address-api.git;\n    - Open the terminal at the this path: address-api/adapter/target\n    - Execute the command: java -jar adapter-0.0.1-SNAPSHOT.jar\n\n    \n   \n## Curl to make the request:\n    curl --location 'localhost:8080/v1/get-address?zipcode=95603620'\n    \n## Link to access the user interface, when the application is running local:\n    http://localhost:8080/swagger-ui/index.html\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarlosfernandoxavier%2Faddress-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcarlosfernandoxavier%2Faddress-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarlosfernandoxavier%2Faddress-api/lists"}