Giter VIP home page Giter VIP logo

go-rest's Introduction

go-rest

Reference repo for a REST API service written in Go. Demonstrates a basic setup using the Gin framework.

Prerequisites

Before you begin, ensure you have the following installed:

  • Go (v1.15 or later)
  • Git

To check the version of Go installed, run the go version command:

Installation

To set up the project on your local machine, follow these steps:

Install Dependencies

The project uses Go Modules for managing dependencies. To install all the necessary dependencies, run:

go mod tidy

This command will download and install all the required packages.

Run the application

To run the application, navigate to the /cmd/api directory and use the go run command:

cd cmd/api
go run main.go

The server should start, and you will see a message indicating that it's listening on a port (default is :8080).

Testing the API

Once the server is running, you can test the API endpoints. For example, to test the /ping endpoint:

curl http://localhost:8080/ping

You should see a response like:

{"message":"pong"}

go-rest's People

Contributors

squidmin 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.