Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dnnrly/httpref
Command line, offline, access to HTTP status code, common header, and port references
https://github.com/dnnrly/httpref
cli go golang golang-package hacktoberfest http
Last synced: 3 months ago
JSON representation
Command line, offline, access to HTTP status code, common header, and port references
- Host: GitHub
- URL: https://github.com/dnnrly/httpref
- Owner: dnnrly
- License: apache-2.0
- Created: 2020-01-10T22:00:47.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-22T22:10:16.000Z (5 months ago)
- Last Synced: 2024-06-23T03:45:57.479Z (5 months ago)
- Topics: cli, go, golang, golang-package, hacktoberfest, http
- Language: Go
- Homepage:
- Size: 291 KB
- Stars: 36
- Watchers: 6
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-go-extra - httpref - 01-10T22:00:47Z|2022-04-06T20:49:10Z| (Go Tools / DevOps Tools)
README
# HTTP Reference
This is a handy little helper that puts HTTP reference at your fingertips, when you're on the CLI, when you need it.
[](https://ko-fi.com/W7W414S4U)
[](https://codecov.io/gh/dnnrly/httpref)
[](http://godoc.org/github.com/dnnrly/httpref)
[](https://goreportcard.com/report/github.com/dnnrly/httpref)
[](https://twitter.com/intent/tweet?url=https://github.com/dnnrly/httpref)
## But why?
Because I can **never** remember what the bloody http status codes mean, or the details of methods, or whatever. It's annoying!
## Why not just wikipedia?
Well it boils down to 2 things:
1. If I use the browser then it means that I have to use the mouse, or a track pad or something.
2. I'm a little bored on a Friday night. There's some rubbish film on. Quite frankly I'm a little bored.
3. If I make it good enough then people will give me stars. This, as everyone knows, is a proxy for love and it will make up for many deficiencies in my life.
4. My attention to detail is incredible. I therefore invite you to sponsor me using the links at the top of the page. :)
Before we get any further, I'm really interested in how you feel about this tool. Please take the time to fill in this short survey: https://forms.gle/mHh6idwwUvdfYZM67
# Installation
```shell
$ go install github.com/dnnrly/httpref/cmd/httpref@latest
```
# Usage
## Filter by Title
```
$ httpref 1
1xx Informational response
100 Continue
101 Switching
102 Processing
103 Early hints
$ httpref 200
200 - OK
The HTTP 200 OK success status response code indicates that the request has succeeded. A 200 response is cacheable by default.
The meaning of a success depends on the HTTP request method:
GET: The resource has been fetched and is transmitted in the message body.
HEAD: The entity headers are in the message body.
POST: The resource describing the result of the action is transmitted in the message body.
TRACE: The message body contains the request message as received by the server.
The successful result of a PUT or a DELETE is often not a 200 OK but a 204 No Content (or a 201 Created when the resource is uploaded for the first time).
https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200
$ httpref
The Content Division element
The
HTML element is the generic container for flow content. It has no effect on the content or
layout until styled in some way using "CSS" (e.g. styling is directly applied to it, or some kind of
layout model like Flexbox is applied to its parent element).
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div
```
## Full-text Search
The `--search` option accepts a term to full-text search. This option is available for header, html, method, and status references.
```
$ httpref --search clear
Clear-Site-Data
Clears browsing data (e.g. cookies, storage, cache) associated with the requesting
website.
205
Reset Content
431
Request Header Fields Too Large
```
## HTML Elements Reference
The `html` subcommand looks up 100+ active and deprecated HTML elements.
```
$ httpref html
The Abbreviation element
The HTML element represents an abbreviation or acronym.
When including an abbreviation or acronym, provide a full expansion of the term in plain text on
first use, along with the "" to mark up the abbreviation. This informs the user what the
abbreviation or acronym means.
The optional "title" attribute can provide an expansion for the abbreviation or acronym when a full
expansion is not present. This provides a hint to user agents on how to announce/display the content
while informing all users what the abbreviation means. If present, "title" must contain this full
description and nothing else.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr
$ httpref html --search anchor
The Anchor element
Content within each "" _should_ indicate the link's destination. If the "href" attribute is
present, pressing the enter key while focused on the "" element will activate it.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a
```
## Important `make` targets
* `deps` - downloads all of the deps you need to build, test, and release
* `build` - builds your application
* `test` - runs unit tests
* `ci-test` - run tests for CI validation
* `acceptance-test` - run the acceptance tests
* `lint` - run linting
* `update` - update Go dependencies
* `clean` - clean project dependencies
* `clean-deps` - remove all of the build dependencies too