Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cooljar/go-whatsapp-fiber
Go WhatsApp REST API Implementation Using Fiber And Swagger
https://github.com/cooljar/go-whatsapp-fiber
docker go go-fiber golang rest-api swagger swagger-ui whatsapp-web
Last synced: 3 months ago
JSON representation
Go WhatsApp REST API Implementation Using Fiber And Swagger
- Host: GitHub
- URL: https://github.com/cooljar/go-whatsapp-fiber
- Owner: cooljar
- Created: 2021-07-19T07:06:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-29T15:14:36.000Z (over 3 years ago)
- Last Synced: 2024-10-08T19:31:07.443Z (4 months ago)
- Topics: docker, go, go-fiber, golang, rest-api, swagger, swagger-ui, whatsapp-web
- Language: Go
- Homepage:
- Size: 362 KB
- Stars: 10
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go WhatsApp REST API Implementation Using Fiber And Swagger
Package cooljar/go-whatsapp-fiber Implements the WhatsApp Web API using [Fiber](https://github.com/gofiber/fiber) web framework,
and also [Swag](https://github.com/gofiber/fiber) to generate Swagger Documentation (2.0).
This repository contains example of implementation [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp) package.
## Getting Started
These instructions will get you a copy of the project up and running on docker container and on your local machine.
### Prerequisites
Prequisites package:
* [Docker](https://www.docker.com/get-started) - for developing, shipping, and running applications (Application Containerization).
* [Go](https://golang.org/) - Go Programming Language
* [Make](https://www.gnu.org/software/make/manual/make.html) - Automated Execution using Makefile
Optional package:
* [gosec](https://github.com/securego/gosec) Golang Security Checker. Inspects source code for security problems by scanning the Go AST
### Running On Docker Container
1. Rename `Makefile.example` to `Makefile` and fill it with your make setting.
2. Run project by using following command:
```bash
$ make run
# Process:
# - Build and run Docker containers
```
Stop application by using following command:
```bash
$ make stop
# Process:
# - Stop and remove app container
# - remove image
```
### Running On Local Machine
Below is the instructions to run this project on your local machine:
1. Rename `run.sh.example` to `run.sh` and fill it with your environment values.
2. Open new `terminal`.
3. Set `run.sh` file permission.
```bash
$ chmod +x ./run.sh
```
4. Run application from terminal by using following command:
```bash
$ ./run.sh
```
### API Access
Go to your API Docs page: [127.0.0.1:3000/swagger/index.html](http://127.0.0.1:3000/swagger/index.html)
API Docs page will be look like:
Below is the instructions to perform messaging:
* Make sure your computer is connected to the internet.
* Prepare your smartphone and make sure the internet is active.
* Hit the [Login](http://127.0.0.1:3000/swagger/index.html#/Whatsapp/post_v1_whatsapp_login) endpoint, you will see a QR Code if request was success.
Check your `Makefile` setting if an error occurred.
* Scant it, and done.
Now you can perform all endpoint to send a message.
## Testing
- Inspects source code for security problems using [gosec](https://github.com/securego/gosec). You need to install it first.
- Execute unit test by using following command:
```bash
$ make test
```
## Built With
* [Go](https://golang.org/) - Go Programming Languange
* [Go Modules](https://github.com/golang/go/wiki/Modules) - Go Dependency Management System
* [Make](https://www.gnu.org/software/make/) - GNU Make Automated Execution
* [Docker](https://www.docker.com/) - Application Containerization
## Authors
* **Fajar Rizky** - *Initial Work* - [cooljar](https://github.com/cooljar)
## More
-------