Code Monkey home page Code Monkey logo

nickemma / gobank-api Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 20.78 MB

The GoBank API is a lightweight and efficient JSON API server implemented in Go. It provides endpoints for managing bank accounts and performing account-related operations. With easy-to-use RESTful endpoints, developers can quickly integrate banking functionalities into their applications.

License: MIT License

Makefile 0.53% Go 99.47%
docker golang gorilla-mux jsonwebtoken postgresql testing bycrypt

gobank-api's Introduction

GoBank API

The GoBank API is a lightweight and efficient JSON API server implemented in Go. It provides endpoints for managing bank accounts and performing account-related operations. With easy-to-use RESTful endpoints, developers can quickly integrate banking functionalities into their applications.

Features

  • Handle GET requests to retrieve account information.
  • Handle POST requests to create new accounts.
  • Handle DELETE requests to delete existing accounts.
  • Handle error responses gracefully.

Setup

1. Clone the repository:

git clone https://github.com/nickemma/gobank-api.git

2. Navigate to the project directory:

 cd gobank-api

3. Build the project:

 go build / make build

4. Run the server:

 go run ./ OR make run

By default, the server listens on localhost:5000. You can customize the listen address by specifying the LISTEN_ADDR environment variable.

API Endpoints

Get Account

 GET /account/{id}

Retrieves account information based on the provided ID.

Create Account

 POST /account

Creates a new account. Requires a JSON payload containing account details (e.g., first name, last name).

Delete Account

 DELETE /account/{id}

Deletes an existing account based on the provided ID.

Error Handling

The API server handles errors gracefully and returns appropriate error responses with descriptive error messages in JSON format.

Dependencies

๐Ÿ‘ค Author

๐Ÿ‘ค Nicholas Emmanuel

Contributing

Contributions are welcome! Feel free to submit issues or pull requests.

License

Please be advised that our project is released under the terms of a License. Please ensure that you read and understand the terms of the MIT License before using our project.

Contact

Nicholas Emmanuel

Linkedin Twitter Github Medium Linkedin

Acknowledgments

  • Creator for the inspiration for this project.
  • LazyCoders For help and support throughout my development journey

gobank-api's People

Contributors

nickemma avatar

Stargazers

 avatar Hatim Eddinani 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.