apichecker

package module
v0.0.0-...-a70b2ce Latest Latest
Warning

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

Go to latest
Published: Jun 19, 2013 License: BSD-3-Clause Imports: 8 Imported by: 0

README

API Checker

API Checker is a Google App Engine application for checking API compatibility/completeness of applications in development, written in Go.

API profiles (APIProfile) can be created with comparison cases (Comp) using either of JSON, XPath, and Header matching methods.

Application profiles (Application), when referred to an APIProfile can be used to check and monitor the API completeness of the application.

Documentation is available at http://godoc.org/github.com/swook/apichecker

The application runs at http://api-checker.appspot.com/

This application is still in development.

Documentation

Overview

Package apichecker is an App Engine application for checking API compatibility or completeness of applications in development

Index

Constants

View Source
const (
	CompJSON = iota
	CompXPath
	CompHeader
)

Variables

This section is empty.

Functions

This section is empty.

Types

type APIProfile

type APIProfile struct {
	ShortName string
	Hosts     []string
	Comps     []Comp
}

Profile defines the expected responses of an API

type Application

type Application struct {
	ShortName string
	API       string // APIProfile.ShortName
	Host      string
}

Application defines an application which implements an API

type Comp

type Comp struct {
	QueryPath   string
	Type        int
	Description string
	Path        string
	DataMatch   string
}

Comp is a struct which defines a comparison case

Jump to

Keyboard shortcuts

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