Skip to content
/ worx Public

Worx is a framework for building APIs in Go with support for TMF (Telecom Management Forum) standards.

Notifications You must be signed in to change notification settings

GraHms/worx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Getting Started

Worx is a framework for building APIs in Go with support for TMF (Telecom Management Forum) standards. Follow these steps to get started:

1. Install Worx:

go get -u github.com/grahms/worx

2. Initialize Your Application:

Create a new Worx application:

package main

import (
	"github.com/grahms/worx"
	"github.com/grahms/worx/router"
)

func main() {
	app := worx.NewApplication("/api", "Product Catalog API")
}

3. Define Your API Endpoint:

Create a new API endpoint using the NewRouter function:

product := worx.NewRouter[Product, ProductResponse](app, "/products")

4. Handle Requests:

Define your request handling logic using the HandleCreate, HandleRead, HandleUpdate, and HandleList methods:

product.HandleCreate("", func(product Product, params *router.RequestParams) (*router.ProcessorError, *ProductResponse) {
	return nil, &ProductResponse{
		Product:  product,
		BaseType: nil,
		Url:      nil,
	}
})

5. Run Your Application:

Start your Worx application and listen on a specified port:

err := app.Run(":8080")
if err != nil {
	panic(err)
}

Now, your Worx application is ready to handle TMF API requests.


Make sure to include the route before defining the handlers to ensure that the routes are properly registered in your application. Happy coding

About

Worx is a framework for building APIs in Go with support for TMF (Telecom Management Forum) standards.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages