publicip-api

command module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 21, 2021 License: MIT Imports: 6 Imported by: 0

README

PublicIP-API Go Report Card Build

A simple HTTP API returning the API of the requesting client

Building

If you are using make you can build the executable with

make build

Otherwise, you can use

go build ./...

Usage

There are to command line flags which modify the functionality of the API

Flag Explanation Default
b Binding IP Address for HTTP Server 127.0.0.1:8080
h Header to retrieve IP address from X-Real-IP

The request to the API should be made in the following format

https://exampleapi.com/?format={format}

Formats json, text and xml are available, if given format is not found/there is no format specified, the api will be defaulting to plain text

Contributing

Every Contribution is welcome, feel free to open pull requests and/or suggest changes in issues

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL