Code Monkey home page Code Monkey logo

simple-geocoding-service-fastapi's Introduction

FastAPI Simple Geocoding Service

A simple API which will return the latitude and longitude for each request using FastAPI and Pgeocode Library

Introduction

This is a simple geocoding service API project using python. One of the library package used for this API is pgeocode. Pgeocode is a python package that provides postal geocoding service. The goal of this API is to mock the large geocoding microservice in order to understand how the API works.

About the API

The architecture of the API can be explained by referring to the diagram below.

Scenario: A client wanted to have latitude and longitude of a certain address. The client will post a request to the api with the raw address. When the API received the address, it will check the geocoding database if the address is already exists. If it is exists, the API will fetch the existing geocoded address and send the response to the client. Otherwise, the API will call the geocoding function to geocode the address. The new geocoded data will save into the database.Then, the API will send it as response to the client.

Running the API

Command: uvicorn main:app --reload

Run Test on the API

Command: pytest

Goodluck!

simple-geocoding-service-fastapi's People

Contributors

azzan-amin-97 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.