Struct APIExpr

expr/api.go:11–52

APIExpr contains the global properties for an API expression.

type (
	// APIExpr contains the global properties for an API expression.
	APIExpr struct {
		// DSLFunc contains the DSL used to initialize the expression.
		eval.DSLFunc
		// Name of API
		Name string
		// Title of API
		Title string
		// Description of API
		Description string
		// Version is the version of the API described by this DSL.
		Version string
		// Servers lists the API hosts.
		Servers []*ServerExpr
		// TermsOfService describes or links to the service terms of API.
		TermsOfService string
		// Contact provides the API users with contact information.
		Contact *ContactExpr
		// License describes the API license.
		License *LicenseExpr
		// Docs points to the API external documentation.
		Docs *DocsExpr
		// Meta is a list of key/value pairs.
		Meta MetaExpr
		// Requirements contains the security requirements that apply to
		// all the API service methods. One requirement is composed of
		// potentially multiple schemes. Incoming requests must validate
		// at least one requirement to be authorized.
		Requirements []*SecurityExpr
		// ClientInterceptors is the list of API client interceptors.
		ClientInterceptors []*InterceptorExpr
		// ServerInterceptors is the list of API server interceptors.
		ServerInterceptors []*InterceptorExpr
		// HTTP contains the HTTP specific API level expressions.
		HTTP *HTTPExpr
		// GRPC contains the gRPC specific API level expressions.
		GRPC *GRPCExpr
		// JSONRPC contains the JSON-RPC specific API level expressions.
		JSONRPC *JSONRPCExpr

		// random generator used to build examples for the API types.
		ExampleGenerator *ExampleGenerator
	}

	// ContactExpr contains the API contact information.
	ContactExpr struct {