Created by: lwj5
Since the operation ID should be unique for each API group, it is more rightly for the routes to be map[string]Route
instead of the name being a field of Route.
Also, this allows for easy embedding compared to using []Route.
For example, if you wish to embed the controller and "override" a DeleteOrder
you would have to "override" the whole Routes()
method like so...
// Routes returns all of the api route for the StoreApiController
func (c *StoreApiController) Routes() Routes {
return Routes{
"DeleteOrder": Route{
strings.ToUpper("Delete"),
"/v2/store/order/{orderId}",
c.DeleteOrder,
},
"GetInventory": Route{
strings.ToUpper("Get"),
"/v2/store/inventory",
c.GetInventory,
},
"GetOrderById": Route{
strings.ToUpper("Get"),
"/v2/store/order/{orderId}",
c.GetOrderById,
},
"PlaceOrder": Route{
strings.ToUpper("Post"),
"/v2/store/order",
c.PlaceOrder,
},
}
}
Now with the new change, you may do:
// Routes returns all of the api route for the StoreApiController
func (c *StoreApiController) Routes() Routes {
routes := c.StoreApiController.Routes() // Get "parent" Routes()
routes["DeleteOrder"] = Route{
strings.ToUpper("Delete"),
"/v2/store/order/{orderId}",
c.DeleteOrder,
}
return routes
}
PR checklist
-
Read the contribution guidelines. -
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community. -
Run the following to build the project and update samples: ./mvnw clean package ./bin/generate-samples.sh ./bin/utils/export_docs_generators.sh
./bin/generate-samples.sh bin/configs/java*
. For Windows users, please run the script in Git BASH. -
File the PR against the correct branch: master
,5.3.x
,6.0.x
-
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
Hi @antihax @grokify @kemokemo @jirikuncar @ph4r5h4d, please help to take a look at this PR