https://github.com/amalfra/etag

A go package to create HTTP ETags
https://github.com/amalfra/etag

etag golang http

Last synced: 19 days ago
JSON representation

A go package to create HTTP ETags

• Host: GitHub
• URL: https://github.com/amalfra/etag
• Owner: amalfra
• License: mit
• Created: 2017-03-11T17:56:39.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-09T11:31:30.000Z (7 months ago)
• Last Synced: 2024-06-21T06:35:04.155Z (5 months ago)
• Topics: etag, golang, http
• Language: Go
• Homepage:
• Size: 16.6 KB
• Stars: 30
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
etag

========

[![GitHub release](https://img.shields.io/github/release/amalfra/etag.svg)](https://github.com/amalfra/etag/releases)

![Build Status](https://github.com/amalfra/etag/actions/workflows/test.yml/badge.svg?branch=main)

[![GoDoc](https://godoc.org/github.com/amalfra/etag/v3?status.svg)](https://godoc.org/github.com/amalfra/etag/v3)

[![Go Report Card](https://goreportcard.com/badge/github.com/amalfra/etag/v3)](https://goreportcard.com/report/github.com/amalfra/etag/v3)

[![Coverage Status](https://coveralls.io/repos/github/amalfra/etag/badge.svg?branch=main)](https://coveralls.io/github/amalfra/etag?branch=main)

A go package to create HTTP ETags (as defined in RFC 7232) for use in HTTP responses.

## Installation

You can download the package using

```sh

go get github.com/amalfra/etag/v3

```

## Usage

Next, import the package

``` go

import (

  "github.com/amalfra/etag/v3"

)

```

You can now call the ```generate``` function to create an ETag. The second parameter is a boolean which specifies whether the generated ETag must be weak or not.

```go

etag.Generate(body, false)

```

to generate a weak Etag

```go

etag.Generate(body, true)

```

## Development

Questions, problems or suggestions? Please post them on the [issue tracker](https://github.com/amalfra/etag/issues).

You can contribute changes by forking the project and submitting a pull request. You can ensure the tests are passing by running ```make test```. Feel free to contribute :heart_eyes:

## UNDER MIT LICENSE

The MIT License (MIT)

Copyright (c) 2017 Amal Francis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.