Giter Club home page Giter Club logo

go-demo-web-api's Introduction

Go demo web-api

Demo web-api written in Go

Effectively the rest example from the official chi project is used and adapted according to need.

Goal

Offer a simple API that can be run easily locally. This API can be treated as a "System Under Test" for api testing.

Architectural Decision(s)

Principle: don't rely on modules that by themselves rely on external depencendies.

http pipeline

The chosen http router is chi. This package provides convenience over having to write the http pipeline boilerplate using the Go std lib. This module is using only the Go std lib, and thus has no external dependencies.

fixture data

gofakeit is used to seed fixture struct data. This module is using only the Go std lib, and thus has no external dependencies.

Slices functions

Since the introduction of generics in Go 1.18 an experimental x/exp/slices package that offers convenience functions when using slices. This package has been accepted to be included in the official Go std lib

Usage

  1. Build the binary in /cmd/server
  2. Run the server binary in your terminal of choice => this will display: "Server starting on localhost:3000"

Endpoints to investigate:

GET:

  • /
  • /ping
  • /clients
  • /clients/{id}

POST:

  • /clients {payload}

PUT:

  • /clients/{id} {payload}

DELETE:

  • /clients/{id}

Payload example

{
    "id": string,
    "name": string,
    "surname": string,
    "birthdate": string,
    "email": string,
    "phone": string,
    "age": number
}

go-demo-web-api's People

Contributors

jeroendee avatar

Stargazers

 avatar

Watchers

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