Docs
Articles Management API Developed under Go (Golang) platform. This project developed using gin framework to ease the development. See Source For all the library used
Index
Overview
- Import the
query.sql
to your MySql Database. - Set your Database Connections (
username/password
inservices/mysql
andcore/sqlboiler.toml
) - Run the project
See Quick Start for example implementations.
Support
You can also email iman.tumorang@gmail.com or file an Issue.
Quick Start
Command Line
Run your project using this command
# download the project into $GOPATH/src
git clone https://github.com/bxcodec/Article-Management-REST-API.git
cd path_of_the_project
# import the query.sql to your mysql server
mysql -u username -p db_name < query.sql
# set your mysql connection authentication
cd "services/mysql"
nano mysql.go
cd "core"
nano sqlboiler.toml
# run the project
go run main.go
If any error happen when running the program caused by missing package, just import it using
go get package_name
command
Running Your API
protocol: http
host : localhost
port : 9090
endpoint: "/v1/articles"
For the API documentation open http://localhost:9090/v1/docs
Source
Below listed all the library used here.
gin
Gin is a web framework written in Go (Golang). It features a martini-like API with much better performance, up to 40 times faster thanks to httprouter. If you need performance and good productivity, you will love Gin.
sqlboiler
SQLBoiler is a tool to generate a Go ORM tailored to your database schema.
It is a "database-first" ORM as opposed to "code-first" (like gorm/gorp). That means you must first create your database schema. Please use something like goose, sql-migrate or some other migration tool to manage this part of the database's life-cycle.
apidoc
Inline Documentation for RESTful web APIs apiDoc creates a documentation from API annotations in your source code.