Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nickemma/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.
https://github.com/nickemma/gobank-api
bycrypt docker golang gorilla-mux jsonwebtoken postgresql testing
Last synced: about 5 hours ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/nickemma/gobank-api
- Owner: nickemma
- License: mit
- Created: 2024-05-09T07:53:41.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-05-22T00:17:28.000Z (6 months ago)
- Last Synced: 2024-06-19T03:40:38.440Z (5 months ago)
- Topics: bycrypt, docker, golang, gorilla-mux, jsonwebtoken, postgresql, testing
- Language: Go
- Homepage:
- Size: 20.3 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```bash
git clone https://github.com/nickemma/gobank-api.git
```
### 2. Navigate to the project directory:
```bash
cd gobank-api
```
### 3. Build the project:
```bash
go build / make build
```
### 4. Run the server:
```bash
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
```bash
GET /account/{id}
```
Retrieves account information based on the provided ID.
## Create Account
```bash
POST /account
```
Creates a new account. Requires a JSON payload containing account details (e.g., first name, last name).
## Delete Account
```bash
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
- Gorilla Mux: https://github.com/gorilla/mux
👤 **Nicholas Emmanuel**
- GitHub: [@NickEmma](https://github.com/NickEmma)
- Twitter: [@techieEmma](https://twitter.com/techieEmma)
- LinkedIn: [@Nicholas Emmanuel](https://www.linkedin.com/in/techieemma/)
## 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) License before using our project.
## Contact
### Nicholas Emmanuel
## Acknowledgments
- [Creator](https://github.com/anthdm) for the inspiration for this project.
- [LazyCoders](https://lazy-coders.netlify.app/) For help and support throughout my development journey