Giter VIP home page Giter VIP logo

http-server-base-go's Introduction

HTTP Server Base

The HTTP server base project is meant to be used as a starting ground for creating a JSON API server.

Running the HTTP server

You can run the HTTP server by running the following command from the root of the project.

The default port will be listening on 8000.

Command

go run cmd/server/main.go

Initial Log Output

2024/03/24 00:41:52 HTTP server starting
2024/03/24 00:41:52 HTTP server listening on port 8000

Basic route endpoint(s)

Success (200)

Request (basic)

curl http://localhost:8000/api/v1/ping

Response

{
    "data": "pong"
}

Request (with metadata)

curl http://localhost:8000/api/v1/metadata

Response

{
    "data": [
        "meta",
        "data"
    ],
    "metadata": {
        "limit": 10,
        "offset": 0,
        "total": 2
    }
}

Error (404)

Request

curl http://localhost:8000/api/v1/notfound

Response

{
    "error": {
        "message": "The path you requested was not found.",
        "status": 404,
        "type": "PATH_NOT_FOUND"
    }
}

Authenticated route endpoints

Missing Authorization header (401)

Request

curl http://localhost:8000/api/v1/auth

Response

{
    "error": {
        "message": "Your request is missing an authorization token.",
        "status": 401,
        "type": "AUTH_TOKEN_MISSING"
    }
}

Invalid Authorization header (401)

Request

curl http://localhost:8000/api/v1/auth --header 'Authorization: Bearer invalid'

Response

{
    "error": {
        "message": "Your request has an invalid authorization token.",
        "status": 401,
        "type": "AUTH_TOKEN_INVALID"
    }
}

Valid Authorization header (200)

Request

curl http://localhost:8000/api/v1/auth --header 'Authorization: Bearer valid'

Response

{
    "data": "authenticated"
}

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.