https://github.com/bfontaine/httpdoc

:notebook: HTTP documentation right in your terminal.
https://github.com/bfontaine/httpdoc

cli go http tool

Last synced: 30 days ago
JSON representation

:notebook: HTTP documentation right in your terminal.

• Host: GitHub
• URL: https://github.com/bfontaine/httpdoc
• Owner: bfontaine
• License: mit
• Created: 2015-04-17T21:11:57.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-03-05T22:49:17.000Z (almost 7 years ago)
• Last Synced: 2024-12-08T21:03:19.712Z (about 1 month ago)
• Topics: cli, go, http, tool
• Language: Go
• Homepage: https://godoc.org/github.com/bfontaine/httpdoc
• Size: 145 KB
• Stars: 35
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# httpdoc

**httpdoc** gives you direct access to HTTP documentation straight from

your terminal.

[![GoDoc](https://godoc.org/github.com/bfontaine/httpdoc?status.svg)](https://godoc.org/github.com/bfontaine/httpdoc)

[![Build Status](https://travis-ci.org/bfontaine/httpdoc.svg?branch=master)](https://travis-ci.org/bfontaine/httpdoc)

## Usage

    httpdoc 

### Examples

    $ httpdoc 200           # => Doc about the status code

    $ httpdoc content-type  # => Doc about the header field

## Install

    go get github.com/bfontaine/httpdoc

`httpdoc` requires Go 1.2+.

### Using Homebrew

If you use [Homebrew](http://brew.sh) or [Linuxbrew](http://linuxbrew.sh/) you

can install `httpdoc` with one command:

```

brew install bfontaine/utils/httpdoc

```

## Go API

```go

import (

    "fmt"

    "github.com/bfontaine/httpdoc/httpdoc"

)

doc := httpdoc.DefaultDoc

code, _ := doc.GetStatusCode("200")

fmt.Println(code.PrettyString())

```

## Support

| Resources                    | Support |

|------------------------------|:-------:|

| Standard status codes        | ✔       |

| Standard header fields       | ✔       |

| Standard methods             | ✔       |

## See Also

* [`rfc`][rfc-cli]: read RFCs in your terminal

[rfc-cli]: https://github.com/bfontaine/rfc#rfc