go-rest-api-service

README

go-rest-api-service

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

⚠ WARNING: go-rest-api-service still in development ⚠ _

At the moment, this is "work-in-progress" with Semantic Versions of 0.n.x. Although it can be reviewed and commented on, the recommendation is not to use it yet.

Synopsis

A RESTful service demonstrating aspects of the SenzingAPI.

Overview

OpenAPI specification:

1. In Swagger UI
2. In Swagger validator
3. In Swagger editor

References

1. Development
2. Errors
3. Examples
4. Package reference

Documentation

Overview

One or two sentence synopsys of the module. The Senzing XXXX module is...

Overview

One or two paragraph overview of this module...

(This page describes the nature of the entire Go module or the top-level command, not an individual package.)

More information at https://github.com/senzing-garage/go-rest-api-service

Example Package

The example package gives an example layout for a package. This includes how documentation, tests, and examples should be done. This paragraph (or two) should provide a brief overview while linking the reader to the documentation included in the package itself.

More information can be found in the pkg/github.com/senzing-garage/go-rest-api-service/examplepackage documentation.

Another Header: Package or other module features...

More details about the module... Lorem ipsum dolor sit amet, consectetur adipiscing elit...

Examples

The examples given here should show a holistic view of the module, if appropriate.

Examples of use can be seen in the main_test.go files.

package main
import (
	fmt

	"github.com/senzing-garage/go-rest-api-service/examplepackage"
	"github.com/senzing-garage/go-rest-api-service/anotherpackage"
)

func main() {
	ctx := context.TODO()
	testObject := &ExamplePackageImpl{
		Something: "I'm here",
	}
	err := testObject.SaySomething(ctx)
	if err != nil {
		fmt.Println("whoops")
	}
	anotherpackage.DoSomething(ctx)...
}