Milogo

Rest Partial Response (aka Field Selection) Pattern middleware for Gin. This gin middleware allows you to select a subset of fields to be returned from your endpoints.

e.g. Imagine that you have the following rest endpoint that returns a product with the fields, code, price, description, manufacturedBy:

/products/1

{
 "code": "1",
 "price": "200",
 "description": "Very nice product",
 "manufacturedBy": "company"
}

We can call the endpoint and, with the query parameter fields, filter out the fields that we are interested:

/products/1?fields=code,price

{
 "code": "1",
 "price": "200"
}

📝 How To Install It And Use It

• Run the command:

go get -u -d github.com/manuelarte/milogo

• Add milogo middleware

r := gin.Default()
r.Use(Milogo())

• Call your endpoints adding the query parameter fields with the fields you want to filter:

/users/1?fields=name,surname

✨ Features

• Support for multiple fields filtering.

/users/manuel?fields=name,surname

{
 "name": "Manuel",
 "surname": "Example"
}

• Support for arrays

/users?fields=name

[
  {
    "name": "Manuel"
  }
]

• Support for nested jsons.

/users/manuel?fields=name,surname,address(street,zipcode)

{
 "name": "Manuel",
 "surname": "Example",
 "address": {
   "street": "mystreet",
   "zipcode": "myzipcode"
 }
}

• Support for wrapped json.

/users/manuel?fields=name

{
 "data": {
    "name": "Manuel"
 }
}

• Middleware applied to route groups with different configuration

Milogo middleware, as any other gin middleware, can be applied to different route groups with different configurations.

🤝 Contributing

Feel free to create a PR or suggest improvements or ideas.

🔗 Contact

• 📧 [email protected]