uritemplates

package module
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Jul 2, 2016 License: BSD-3-Clause Imports: 7 Imported by: 102

README

uritemplates

-- import "github.com/jtacoma/uritemplates"

Build Status Coverage Status

Package uritemplates is a level 4 implementation of RFC 6570 (URI Template, http://tools.ietf.org/html/rfc6570).

To use uritemplates, parse a template string and expand it with a value map:

template, _ := uritemplates.Parse("https://api.github.com/repos{/user,repo}")
values := make(map[string]interface{})
values["user"] = "jtacoma"
values["repo"] = "uritemplates"
expanded, _ := template.Expand(values)
fmt.Printf(expanded)

License

Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.

Documentation

Overview

Package uritemplates is a level 4 implementation of RFC 6570 (URI Template, http://tools.ietf.org/html/rfc6570).

To use uritemplates, parse a template string and expand it with a value map:

template, _ := uritemplates.Parse("https://api.github.com/repos{/user,repo}")
values := make(map[string]interface{})
values["user"] = "jtacoma"
values["repo"] = "uritemplates"
expanded, _ := template.Expand(values)
fmt.Printf(expanded)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type UriTemplate

type UriTemplate struct {
	// contains filtered or unexported fields
}

A UriTemplate is a parsed representation of a URI template.

func Parse

func Parse(rawtemplate string) (template *UriTemplate, err error)

Parse parses a URI template string into a UriTemplate object.

func (*UriTemplate) Expand

func (self *UriTemplate) Expand(value interface{}) (string, error)

Expand expands a URI template with a set of values to produce a string.

func (*UriTemplate) Names

func (self *UriTemplate) Names() []string

Names returns the names of all variables within the template.

func (UriTemplate) String

func (t UriTemplate) String() string

Jump to

Keyboard shortcuts

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