iwita b9152718d2 new version 5 anos atrás
..
.editorconfig b9152718d2 new version 5 anos atrás
.gitignore b9152718d2 new version 5 anos atrás
.golangci.yml b9152718d2 new version 5 anos atrás
.travis.yml b9152718d2 new version 5 anos atrás
BUILD b9152718d2 new version 5 anos atrás
CODE_OF_CONDUCT.md b9152718d2 new version 5 anos atrás
LICENSE b9152718d2 new version 5 anos atrás
README.md b9152718d2 new version 5 anos atrás
bson.go b9152718d2 new version 5 anos atrás
date.go b9152718d2 new version 5 anos atrás
default.go b9152718d2 new version 5 anos atrás
doc.go b9152718d2 new version 5 anos atrás
duration.go b9152718d2 new version 5 anos atrás
format.go b9152718d2 new version 5 anos atrás
go.mod b9152718d2 new version 5 anos atrás
go.sum b9152718d2 new version 5 anos atrás
time.go b9152718d2 new version 5 anos atrás

README.md

Strfmt Build Status codecov Slack Status

license GoDoc GolangCI Go Report Card

This package exposes a registry of data types to support string formats in the go-openapi toolkit.

strfmt represents a well known string format such as credit card or email. The go toolkit for OpenAPI specifications knows how to deal with those.

Supported data formats

go-openapi/strfmt follows the swagger 2.0 specification with the following formats defined here.

It also provides convenient extensions to go-openapi users.

  • JSON-schema draft 4 formats
    • date-time
    • email
    • hostname
    • ipv4
    • ipv6
    • uri
  • swagger 2.0 format extensions
    • binary
    • byte (e.g. base64 encoded string)
    • date (e.g. "1970-01-01")
    • password
  • go-openapi custom format extensions
    • bsonobjectid (BSON objectID)
    • creditcard
    • duration (e.g. "3 weeks", "1ms")
    • hexcolor (e.g. "#FFFFFF")
    • isbn, isbn10, isbn13
    • mac (e.g "01:02:03:04:05:06")
    • rgbcolor (e.g. "rgb(100,100,100)")
    • ssn
    • uuid, uuid3, uuid4, uuid5
    • cidr (e.g. "192.0.2.1/24", "2001:db8:a0b:12f0::1/32")

NOTE: as the name stands for, this package is intended to support string formatting only. It does not provide validation for numerical values with swagger format extension for JSON types "number" or "integer" (e.g. float, double, int32...).

Format types

Types defined in strfmt expose marshaling and validation capabilities.

List of defined types:

  • Base64
  • CreditCard
  • Date
  • DateTime
  • Duration
  • Email
  • HexColor
  • Hostname
  • IPv4
  • IPv6
  • CIDR
  • ISBN
  • ISBN10
  • ISBN13
  • MAC
  • ObjectId
  • Password
  • RGBColor
  • SSN
  • URI
  • UUID
  • UUID3
  • UUID4
  • UUID5