Skip to content

umerm-work/xm-exercise

Repository files navigation

Company Service

This service is use to company. It includes the following operations

  • Add company
  • List company
  • Update company
  • Remove company

Architecture

alt text

Use Cases

The software in this layer contains application specific business rules. It encapsulates and implements all of the use cases of the system.

Interface Adapters

The software in this layer is a set of adapters that convert data from the format most convenient for the use cases and entities, to the format most convenient for some external agency such as the Database or the Web.

Infrastructure / Frameworks and Drivers.

The outermost layer is generally composed of frameworks and tools such as the Database, the Web Framework, etc.

Setup

Create database first and update the credentials in config/config.go file.

After updating the file use the following command to download packages

make deps

NOTE : Go modules should be enabled.

Run

Use one of the following commands to run the app

make run

or

go run main.go

API's

API Methood Example Auth
/company POST Cyprus IP Required
/company/{id} DELETE /company/1 Cyprus IP Required
/company GET This endpoint is used for filtering. All properties are filterable. Example /company?id=1 OR /company?name=abc
/company PUT

Add Company

JSON Body

{ "name":"Go", "code":"h", "website":"hello.com", "phone":"123", "country":"se" }

Update Company

id is mandatory in update method.

JSON Body

{ "id":1 "name":"Go", "code":"h", "website":"hello.com", "phone":"123", "country":"se" }

Company Filters

Filters can be applied on all property Endpoint

/company?propertyName=value

Examples

/company?code=abc

/company?name=abc

/company?website=abc

/company?country=cy

/company?id=1

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published